jose wrote: > 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 ?
Sorry, I misunderstood your post. I had believed that you needed to document just one function, implying that the author of the function didn't understand the function's purpose well enough to write a good description as Rebol code. Sorry about that. Most of my Values functions include the Example in the header, which is useful when I forget how to use the function! (That's a sign to me that the function probably isn't intuitive enough yet.) I also need to revisit those few that aren't up to scratch and fix them up. > 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, ..) Yes, this automatic summary would be very good. A dictionary can be generated by loading all the scripts in the Values/ directory (basically running the %Values.r script from %User.r) and simply running the dictionary script from Rebol.com. http://www.rebol.com/view/docs/make-ref.r Which (after fixing a bug in my %Patches.r script), doesn't actually show my Values/ functions? Hmmm... I feel that the dictionary idea is best, once I find out how to get my Values/ to be included. Does anyone know how to do this? I'm almost sure it's probably a simple modification of make-ref.r Andrew Martin ICQ: 26227169 http://valley.150m.com/ -><- ----- Original Message ----- From: "jose" <[EMAIL PROTECTED]> To: <[EMAIL PROTECTED]> Sent: Friday, August 30, 2002 9:13 PM Subject: [REBOL] Re: documenting > 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 <[EMAIL PROTECTED]> escribi�: > jose > wrote: > > > Has anybody modified rebdoc to document the > > functions in a set of scripts, > > either in HTML or even better PDF? > > > > I haven't. But,... > > > > If you really need to document your own Rebol > > functions, then I respectfully > > suggest that you need to rewrite them to a higher > > standard. Rebol can easily > > be self documenting, I believe. > > > > Andrew Martin > > ICQ: 26227169 http://valley.150m.com/ > > -><- > > > > > > -- > > To unsubscribe from this list, please send an email > > to > > [EMAIL PROTECTED] with "unsubscribe" in the > > subject, without the quotes. > > > > _______________________________________________________________ > Yahoo! Messenger > Nueva versi�n: Webcam, voz, y mucho m�s �Gratis! > Desc�rgalo ya desde http://messenger.yahoo.es > -- > To unsubscribe from this list, please send an email to > [EMAIL PROTECTED] with "unsubscribe" in the > subject, without the quotes. > > -- To unsubscribe from this list, please send an email to [EMAIL PROTECTED] with "unsubscribe" in the subject, without the quotes.
