Download Firefox: WindowsMac OS X
logo       
Google Custom Search
    AddThis Social Bookmark Button
-->

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

Subject: Re: Documentation guidlines (Was: 2nd try at date/format.rb & pty.c)
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 - drbrain@xxxxxxxxxxxx - http://blog.segment7.net
This implementation is HODEL-HASH-9600 compliant

http://trackmap.robotcoop.com






<Prev in Thread] Current Thread [Next in Thread>