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 19, 2006, at 5:46 PM, Eric Hodel wrote: > On Aug 19, 2006, at 4:14 PM, James Britt wrote: >> I'm unaware of any mention of "give it a whirl" on ruby-doc.org, >> but I get the point. If someone has some good guidelines for >> people willing to write docs I'll put them up on ruby-doc.org. > > Here's a start: > > * Documentation wrapped to 80 characters > * Use :: and # for describing methods, . for example code > * C methods must have call-seq Also, the 'submit to Gavin Sinclair' should be switched to 'submit to the ruby-doc mailing list'. -- Eric Hodel - [email protected] - http://blog.segment7.net This implementation is HODEL-HASH-9600 compliant http://trackmap.robotcoop.com