Re: Documentation guidlines (Was: 2nd try at date/format.rb & pty.c)
James Britt <[email protected]>
| Newsgroups | gmane.comp.lang.ruby.documentation |
|---|---|
| Organization | ruby-doc.org |
| Message-ID | <[email protected]> |
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. James