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#00042

Subject: Re: Documentation guidlines (Was: 2nd try at date/format.rb & pty.c)
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 - 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>