Poll: what documentation method do you use?

[john maclean]

* ri
* source code
* rbbr
* the net/google
* irc and ask
* malining list and ask
* none of the above

--
John Maclean
07739 171 531
MSc (DIC)

Timezone: GMT

 

[Michael Malone]

* ri
* source code
* rbbr
* the net/google
* irc and ask
* malining list and ask
* none of the above

* "The ruby sidebar" - which I guess falls under the net.
* ri
* google
* more experienced co-worker

=======================================================================
This email, including any attachments, is only for the intended
addressee. It is subject to copyright, is confidential and may be
the subject of legal or other privilege, none of which is waived or
lost by reason of this transmission.
If the receiver is not the intended addressee, please accept our
apologies, notify us by return, delete all copies and perform no
other act on the email.
Unfortunately, we cannot warrant that the email has not been
altered or corrupted during transmission.
=======================================================================

 

[Phlip]

* malining list and ask

maligning the list? How could we?? (-:

* none of the above

I wrote a QnD documenter called "ripdoc", based on Ruby1.9 Ripper. That means it
uses Ruby's own parse tree to lex Ruby. Then I traverse this tree and emit HTML
with CSS tags.

Then, I documents the test cases. I move the exemplary ones to the top, put them
into thematic order like an outline, and write comments all over them.

This page contains the result:

http://assert2.rubyforge.org/

 

[Todd Benson]

* source code rarely

* rbbr
* the net/google

almost solely the rdoc available on ruby-doc, rarely google

* irc and ask
* malining list and ask

though uncategorized for me, I use the list for learning

irb is your friend and after much experimentation is almost documentation

Todd

 

[Fernando Perez]

I used for a long time ruby-doc.org, but now that I discovered that irb
can be tweaked with format=ansi --no-pager --interactive, I'll be using
it more often.

If I have no idea where to look my method for, I sometimes use
railsbrain.com or this mailing-list.