On Aug 19, 2006, at 4:14 PM, James Britt wrote:
Eric Hodel wrote:
On Aug 19, 2006, at 8:17 AM, Mat Schaffer wrote:
Okay, if I posted a list of guidelines for people trying to help
out on this, would someone please post it? It is really
discouraging to try this twice and get shot down both times.
It's not like I'm a newb to programming/commenting, there's just
no guidelines to follow other than "give it a whirl" on the
stdlib intro pages. So I'm stuck wasting everyone's time and
mine with this trial and error.
That would be cool, I think it should replace the 'give it a
whirl' comment. I only check stuff in to ruby, I don't have
access to the ruby-doc.org.
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
--
Eric Hodel - drbrain@xxxxxxxxxxxx - http://blog.segment7.net
This implementation is HODEL-HASH-9600 compliant
http://trackmap.robotcoop.com
|
