logo       

Re: corrected typo on rdoc docs, and clarification: msg#00024

Subject: Re: corrected typo on rdoc docs, and clarification
On Friday, November 12, 2004, 1:28:41 PM, Sam wrote:

> Quoteing jbritt@xxxxxxxxxxxx, on Thu, Nov 11, 2004 at 07:23:37PM -0700:
>> Sam Roberts wrote:
>> 
>> >Should doc patches be sent here?
>> 
>> Depends, sort of.  Documentation for the core classes and the standard
>> library come from the rdoc comments in the source code.  There are some
>> here who have CVS commit access who could apply the change.

> Let me put it this way... I'm willing to hack the src doc comments, and
> I'm willing to push the cvs diffs towards one mailing list, but not
> to hunt down individual authors. The docs are important, and it doesn't
> take too much effort for me to add things to some of the almost
> undocumented libraries.

> The ruby-doc.org page gave the strong impression that there is a group
> working through the stdlibs adding docs.

> Is this not the case?

> Should I be subscribed to ruby-core, and posting doc diffs there?

I'm more than happy to see doc patches here.  I agree that people
making to effort to correct things should not then face administrative
hurdles.  Furthermore, I'm happy to do the administrative legwork.
(Although I'll be on holiday for a month around Christmas...)

James is correct to point out that different kinds of patches should
be treated differently.  But this is a good place for discussing them.

Cheers,
Gavin






<Prev in Thread] Current Thread [Next in Thread>
Google Custom Search

Recently Viewed:
linux.arklinux....    user-groups.lin...    kde.usability/2...    ietf.ipp/2002-0...    mail.spam.spamc...    os.netbsd.devel...    audio.cd-record...    text.unicode.de...    php.documentati...    games.fps.halfl...    window-managers...    suse.oracle.gen...    bug-tracking.gn...    video.dvdrip.us...    xfree86.cvs/200...    java.netbeans.m...    network.argus/2...    culture.sf.kill...    debian.ports.al...    freebsd.questio...    qplus.devel/200...    handhelds.palm....   
Home | blog view | USPTO Patent Archive | advertise | OSDir is an inevitable website. super tiny logo

Free Magazines

Cisco News
Receive a free quarterly e-newsletter with exclusive articles on how Cisco IT uses its own products and solutions to enable the business.
subscribe

Systems Management News, the newspaper for IT systems administration and data center managers! Each issue of Systems Management News is chock-full of news and analysis to help you understand what's happening in your field.
subscribe

The Enterprise Newsweekly eWeek is the essential technology information source for builders of e-business.
subscribe

Oracle Magazine Oracle Magazine contains technology strategy articles, sample code, tips, Oracle and partner news, how to articles for developers and DBAs, and more. Oracle (NASDAQ: ORCL) is the world's largest enterprise software company.
subscribe

Total Telecom Total Telecom is "The Economist of the communications industry".
subscribe