[REBOL] Re: documenting
From: jjmmes:yaho:o:es at: 30-Aug-2002 11:13
Hi Andrew,
Do you consider that your Values functions are in to
the higher documentation standard ? To me, that is the
basic way to document proposed by rebol and more than
enough (in fact more than basic, because you include
Example in many headers and I recall RT has separate
files with more info like examples, etc..).
I don't view that as a rewrite. What ideas you have on
this ?
Going back to your Values lib, I'm sure you have very
useful functions but without an automatic summary like
the one I propose it's hard for others to adopt (think
of learning rebol core but not having a list of the
functions, ..)
I think when you write a ton of functions you need to
have some sort of structure that makes them useful to
others because the overall structure is normally only
in the head of the developer.
With a simple script you can have a basic
clasification (+ the help output) like
text processing: func1 func2
cgi: func3 func4
list processing: func5 ...
dialects: funcX
and for each func
--USE:
--DESCRIPTION:
--ARGUMENTS:
Does this make sense ?
--- Andrew Martin <[Al--Bri--xtra--co--nz]> escribió: > jose
wrote:
