Opened 10 years ago

Closed 9 years ago

Last modified 8 years ago

#162 closed task (fixed)

add documentation for srfi-4, srfi-13, srfi-14 and srfi-18 to manual

Reported by: felix winkelmann Owned by: Jim Ursetto
Priority: minor Milestone:
Component: documentation Version: 4.3.x
Keywords: manual chicken-doc Cc: Jim Ursetto
Estimated difficulty:

Description

That way those units would be covered by chicken-doc.

Change History (12)

comment:1 Changed 10 years ago by felix winkelmann

This should also include srfi-12

comment:2 Changed 10 years ago by (none)

Milestone 4.4.0 deleted

comment:3 Changed 9 years ago by Jim Ursetto

Milestone: 4.5.0

Should we import the entire contents of each SRFI or just the definitions (procedures, parameters, etc.)?

If only the definitions, then a link from the main page to the SRFI text would still be provided.

comment:4 Changed 9 years ago by Jim Ursetto

Owner: set to Jim Ursetto
Status: newassigned

comment:5 Changed 9 years ago by Jim Ursetto

I added srfi-13, srfi-14, srfi-18 to the manual and updated srfi-1 with better markup.

I have srfi-12 ready, but need to know how to add it. Procedures are currently in Unit library. Should I emulate the srfi-18 doc and move those procedures into a new document "Unit srfi-12" along with the new documentation? I did not do this yet because technically srfi-12 is not a real unit. Mainly I just need to know what to call the new document.

srfi-4 is still forthcoming.

Relevant SVN changes so far are r17856,r17857,r17860,r17861

FYI I wrote a generic html to svnwiki parser to handle the conversion plus some additional hacks for individual SRFIs (no two are alike!) Naturally some content hacking is still required. If you are interested the code is available at

git clone git://3e8.org/srfi-doc.git

comment:6 Changed 9 years ago by Jim Ursetto

Uploaded srfi-4 now as r17862

comment:7 in reply to:  5 ; Changed 9 years ago by felix winkelmann

Replying to zbigniew:

I added srfi-13, srfi-14, srfi-18 to the manual and updated srfi-1 with better markup.

I have srfi-12 ready, but need to know how to add it. Procedures are currently in Unit library. Should I emulate the srfi-18 doc and move those procedures into a new document "Unit srfi-12" along with the new documentation? I did not do this yet because technically srfi-12 is not a real unit. Mainly I just need to know what to call the new document.

I would integrate it into the library unit page.

FYI I wrote a generic html to svnwiki parser to handle the conversion plus some additional hacks for individual SRFIs (no two are alike!) Naturally some content hacking is still required. If you are interested the code is available at

git clone git://3e8.org/srfi-doc.git

Cool - we should put this into SVN (perhaps the "maintenance/" directory?)

Thanks!

comment:8 Changed 9 years ago by felix winkelmann

Milestone: 4.5.04.6.0

comment:9 in reply to:  7 Changed 9 years ago by felix winkelmann

Replying to felix:

Replying to zbigniew:

I added srfi-13, srfi-14, srfi-18 to the manual and updated srfi-1 with better markup.

I have srfi-12 ready, but need to know how to add it. Procedures are currently in Unit library. Should I emulate the srfi-18 doc and move those procedures into a new document "Unit srfi-12" along with the new documentation? I did not do this yet because technically srfi-12 is not a real unit. Mainly I just need to know what to call the new document.

I would integrate it into the library unit page.

That would of course a silly thing to do. I suggest adding a new chapter named Exceptions.

comment:10 Changed 9 years ago by felix winkelmann

I see that this has been added. Excellent - thanks, zbigniew! I have also added the chapter to the git repo.

Does this mean we can close this ticket?

comment:11 Changed 9 years ago by Jim Ursetto

Resolution: fixed
Status: assignedclosed

comment:12 Changed 8 years ago by felix winkelmann

Milestone: 4.6.0

Milestone 4.6.0 deleted

Note: See TracTickets for help on using tickets.