# Library documenting tutorial

**URL:** <https://www.ruby-forum.com/t/library-documenting-tutorial/87874>\
**Category:** Ruby\
**Created:** [March 6, 2007, 4:28pm UTC](https://www.ruby-forum.com/t/library-documenting-tutorial/87874 "2007-03-06T16:28:28Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![Victor\_SZverokSS\_Sh](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/v/f04885/32.png) [@Victor\_SZverokSS\_Sh](https://www.ruby-forum.com/u/Victor_SZverokSS_Sh)\
**Post date:** [March 6, 2007, 4:28pm UTC](https://www.ruby-forum.com/t/library-documenting-tutorial/87874/1 "2007-03-06T16:28:28Z")

</div>

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.

---

<div class="post-metadata">

**Author:** ![Victor\_SZverokSS\_Sh](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/v/f04885/32.png) [@Victor\_SZverokSS\_Sh](https://www.ruby-forum.com/u/Victor_SZverokSS_Sh)\
**Post date:** [March 6, 2007, 4:47pm UTC](https://www.ruby-forum.com/t/library-documenting-tutorial/87874/2 "2007-03-06T16:47:33Z")

</div>

On 3/6/07, Victor Zverok S. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:

> 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 T.'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

---

<div class="post-metadata">

**Author:** ![Victor\_SZverokSS\_Sh](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/v/f04885/32.png) [@Victor\_SZverokSS\_Sh](https://www.ruby-forum.com/u/Victor_SZverokSS_Sh)\
**Post date:** [March 6, 2007, 4:54pm UTC](https://www.ruby-forum.com/t/library-documenting-tutorial/87874/3 "2007-03-06T16:54:34Z")

</div>

From: Tim P. [[mailto:removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid)]  
Sent: Tuesday, March 06, 2007 5:47 PM

> 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 T.'s Test::Unit rdoc is also a good example. That, too,  
> can be found in the Ruby source code:
> 
> $RUBY\_SRC/lib/test/unit

Yeah, I understand.  
Just wanted to enjoy my lazyness with a small tutorial, showing all the  
essentials at one page.

Instead, it seems like I have to enjoy my diligence by documenting my  
library and than writing such kind of tutorial by myself 🙂

V.

---

<div class="post-metadata">

**Author:** ![Victor\_SZverokSS\_Sh](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/v/f04885/32.png) [@Victor\_SZverokSS\_Sh](https://www.ruby-forum.com/u/Victor_SZverokSS_Sh)\
**Post date:** [March 6, 2007, 8:17pm UTC](https://www.ruby-forum.com/t/library-documenting-tutorial/87874/4 "2007-03-06T20:17:20Z")

</div>

> > > 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.

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.