[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Chicken-hackers] Beginnings of a new manual
From: |
Peter Bex |
Subject: |
[Chicken-hackers] Beginnings of a new manual |
Date: |
Mon, 8 May 2017 22:23:55 +0200 |
User-agent: |
Mutt/1.5.23 (2014-03-12) |
Hi all,
Since we've been making good progress, I've started work on a new manual
for CHICKEN 5. To make it easier to collaborate I decided to put it up
on the wiki.
You can see it here: http://wiki.call-cc.org/man/5
I've created a basic org file that reflects the intended structure at
http://wiki.call-cc.org/man/5/TODO/new-manual.org
compare this with the old one at
http://wiki.call-cc.org/man/5/TODO/old-manual.org
It still needs a _LOT_ of work, and so far most of the work has been
put into moving stuff around from the old "Unit xyz" to their
corresponding "Module xyz" under the "Included modules" page.
I have put the old manual pages under TODO/, so we should be able to
easily measure our progress; as soon as all docs have been moved out
of a wiki page into a new one, it'll be empty and we can delete it.
So far I've deleted "Unit repl", "Unit extras", "Unit files", "Unit
continuation" and "Unit tcp" in this manner.
A few things that popped up during work on this:
- It's quite confusing that process-signal is not in
(chicken process signal). I understand the reasoning we
had when we decided to put it in (chicken process), but
maybe it makes more sense to go with what my gut feeling
says.
- The symbolic link procedures and file-modification-time are in
(chicken file), while file-access-time, file-change-time and
the hardlink procedure "file-link" are in (chicken file posix).
This is weird. Shouldn't the file-*-time things all go in the
same module?
- Where should we put keyword-style? I thought it would fit in
nicely with chicken.keyword, but then I noticed we have other
parameters that control the reader, like case-sensitive,
parentheses-synonyms and symbol-escape.
- The (chicken io) module on c-l-r mentions "read*", what's that?
There are no docs and it doesn't exist.
- current-read-table is still missing from (chicken read-syntax).
I have added it to the c-l-r wiki page and changed its status
back from [done] to [partial]. I made the identifier bold to
indicate it as missing.
Please, feel free to rearrange things in the org file. If you do,
please remember to change the prev/next links of the surrounding pages,
I've been using it as a reference to ensure those links are correct.
Cheers,
Peter
signature.asc
Description: Digital signature
- [Chicken-hackers] Beginnings of a new manual,
Peter Bex <=