|
From: | Ralf Hemmecke |
Subject: | Re: [Axiom-developer] Issues with documentation revisions |
Date: | Mon, 14 Aug 2006 10:57:45 +0200 |
User-agent: | Thunderbird 1.5.0.5 (X11/20060719) |
http://zwiki.org/NewAutodocPamphletI am not a lisp programmer at all, but the lisp code is missing ">>" so I guess, a line like
<<pa SHORT Long=will be accepted as introducing a code chunk name. I am pretty sure that I could even produce a valid Aldor program that contains exactly this line.
William, I like your style much more than the original one fromhttp://zwiki.org/AutodocPamphlet , but I was once told that I should write an executive summary. Honestly, when I read the abstract it was not completely clear to me what this program does. It is nice that you show the usage, but I must say, if the output is not too long, it is also illustrative to include it in the Usage section. (That should even be a kind of simple unit test.)
Ralf
[Prev in Thread] | Current Thread | [Next in Thread] |