Library documenting tutorial

[Victor \Zverok\ Shepelev]

Hi all.

Is there something like tutorial on documenting my own libraries with RDoc?

I'm interested not in technical details, but in ideological advices and
common practicies.

Thanks.

V.

 

[Tim Pease]

Hi all.

Is there something like tutorial on documenting my own libraries with RDoc?

I'm interested not in technical details, but in ideological advices and
common practicies.

If you have a copy of the Ruby source code, Matz has a nice
documentation style in the core classes. That would be a good
convention to follow.

Nathaniel Talbott's Test::Unit rdoc is also a good example. That, too,
can be found in the Ruby source code:

$RUBY_SRC/lib/test/unit

Blessings,
TwP

 

[Giles Bowkett]

Is there something like tutorial on documenting my own libraries with
There's another reason to love the Ruby community. People wanting to
find out how to get their documentation exactly right. That's a good
thing. Sorry a tutorial like that doesn't exist to my knowledge either
but you can get a pretty good feel for it by reading core libraries,
as Tim said.