Re: 2nd try at date/format.rb & pty.c

Mat Schaffer <[email protected]>
Newsgroups gmane.comp.lang.ruby.documentation
Message-ID <[email protected]>
On Aug 19, 2006, at 7: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.
>>> -Mat
>> 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.

The "give it a whirl" that I'm paraphrasing is here: http://www.ruby- 
doc.org/stdlib/status.html
It's just basically all I've had to go on other than this list when  
trying to become a ruby documenter.  I'd love to see a real step by  
step guide at making really good documentation that will be accepted  
by the ruby core.

Let's build some guidlines on the list, and if no-one else beats me  
to it, I'll draft up a guide.  Would you prefer HTML or textile or  
<insert markup here>?
-Mat
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.