News for hackers. Stuff that matters.

A comment on Cyclone Scheme. Parent comment

Re:Cyclone Scheme by hajile on Tuesday October 06, 2020 @11:01AM (#24698365)
To the Cyclone devs, If you want real-world users make sure you address the glaring documentation issues.

I'd recommend moving the SRFI list to a footnote. Have your own API documentation with examples. Instead of SRFI-69, have an entry for hash tables. Mention at the bottom that you comply with SRFI-69 with a link to the spec, but have your own docs that show how to use those APIs instead. Also make sure you document all the r7rs-small functions and data types too.

[ Parent | on HN ]
Re:Cyclone Scheme by justinethier on Tuesday October 06, 2020 @11:15AM (#24698536)
We have our own pages such as:

http://justinethier.github.io/cyclone/docs/api/srfi/69

Admittedly this does not include examples.

Perhaps it needs to be more clear that the API documentation contains links both to our internal docs as well as the official SRFI pages:

http://justinethier.github.io/cyclone/docs/API#srfi-librarie...

[ Parent | on HN ]