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 9:03 AM, James Britt wrote: > mathew wrote: >> Eric Hodel wrote: >>> Here's a start: >>> >>> * Documentation wrapped to 80 characters >>> * Use :: and # for describing methods, . for example code >>> * C methods must have call-seq >> * Include plenty of examples. > > And the examples should include the call to 'require' needed to > load the library. I'd like for this to be automatic, but hacking that part of RDoc is hard. -- Eric Hodel - [email protected] - http://blog.segment7.net This implementation is HODEL-HASH-9600 compliant http://trackmap.robotcoop.com