Re: Documentation guidlines (Was: 2nd try at date/format.rb & pty.c)
Eric Hodel <[email protected]>
| Newsgroups | gmane.comp.lang.ruby.documentation |
|---|---|
| Message-ID | <[email protected]> |
On Aug 21, 2006, at 8:00 AM, Mat Schaffer wrote: > On Aug 21, 2006, at 10:22 AM, mathew wrote: >> * Make the first page (the one named after the package/library) >> contain an introduction to what the package does, why you should >> use it, and links to any relevant standards (e.g. RFCs). > 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? The module/class comment goes in front of Init_blah. -- Eric Hodel - [email protected] - http://blog.segment7.net This implementation is HODEL-HASH-9600 compliant http://trackmap.robotcoop.com