Re: Documentation guidlines (Was: 2nd try at date/format.rb & pty.c)

Mat Schaffer wrote:
> Actually, I was wondering about this.  When I patched pty.c, clicking 
> on the pty link still yielded shl.rb.  How can I fix it to reference 
> the PTY class?  Also, where can you place summary information for a C 
> file.  Can you just put it at the top?

Take a look at bigdecimal if you need an example. Lots of that was C 
code. I experimented quite a bit to find out where to comment things, to 
get the comments to show up in the right place in the Rdoc.

> At first I thought the enumerable stuff looked okay, but I see what 
> you mean about documenting internals.  each_cons and each_slice look 
> okay though right?

Yes, though they're a bit terse... I had to read each_cons through about 
3 times before I understood what it was doing, and I'd probably have 
been lost without the example.


mathew