headers
Sam Goldman | 10 May 2005 14:18
Favicon

Here to help

Okay, I am done with school for the summer and I'd like to help  
document whatever needs documenting. I was looking for a kind of  
"status" page on the web site but I could find none.

Hope I can be of some help.

- Sam
Permalink | Reply | 10 comments |
headers
James Britt | 10 May 2005 15:05
Favicon

Re: Here to help

Sam Goldman wrote:
> Okay, I am done with school for the summer and I'd like to help  
> document whatever needs documenting. I was looking for a kind of  
> "status" page on the web site but I could find none.

There is no status page as as such, but if you look at the index page 
for the standard library documentation [0] you'll see that some library 
names are italicized.  These are libraries with little or no 
documentation.  Some examples are enumerator and mathn.

> 
> Hope I can be of some help.

Same here.  Please speak up if you have questions or problems.

And thanks!

James Britt

[0] http://www.ruby-doc.org/stdlib/
Permalink | Reply | 9 comments |
headers
George Ogata | 10 May 2005 15:18
Picon

Re: Here to help

James Britt <jbritt <at> ruby-doc.org> writes:

> Sam Goldman wrote:
>> Okay, I am done with school for the summer and I'd like to help
>> document whatever needs documenting. I was looking for a kind of
>> "status" page on the web site but I could find none.
>
> There is no status page as as such, but if you look at the index page
> for the standard library documentation [0] you'll see that some
> library names are italicized.  These are libraries with little or no
> documentation.  Some examples are enumerator and mathn.
>
>
>> Hope I can be of some help.
>
>
> Same here.  Please speak up if you have questions or problems.
>
> And thanks!
>
>
> James Britt
>
>
> [0] http://www.ruby-doc.org/stdlib/

"No status page"?  On the left frame of that very page, there's a
"Status Report" link with some added descriptions on what needs to be
done.  :)
(Continue reading)

Permalink | Reply | 8 comments |
headers
Sam Goldman | 10 May 2005 15:44
Favicon

Re: Here to help

Thanks James and George.

Before I start, which version(s?) of Ruby are we documenting? I'm  
sure this is in the web site somewhere, but I couldn't find it when I  
looked (perhaps in the wrong places?). I'm running 1.8.2.

- Sam
Permalink | Reply | 6 comments |
headers
George Ogata | 10 May 2005 15:52
Picon

Re: Here to help

Sam Goldman <samgoldman <at> jhu.edu> writes:

> Thanks James and George.
>
> Before I start, which version(s?) of Ruby are we documenting? I'm
> sure this is in the web site somewhere, but I couldn't find it when I
> looked (perhaps in the wrong places?). I'm running 1.8.2.
>
> - Sam

I think most people work with CVS HEAD (that's 1.9).  For the most
part, though, it should be the same as latest stable (1.8.2).

As for what I said before about the manpage: I just noticed the debian
package has manpages for irb and ri.  Is there any reason these
can't/shouldn't be absorbed into the standard ruby distribution?
Permalink | Reply | 5 comments |
headers
Curt Hibbs | 10 May 2005 16:52

Re: Here to help

George Ogata wrote:
> Sam Goldman <samgoldman <at> jhu.edu> writes:
> 
> 
>>Thanks James and George.
>>
>>Before I start, which version(s?) of Ruby are we documenting? I'm
>>sure this is in the web site somewhere, but I couldn't find it when I
>>looked (perhaps in the wrong places?). I'm running 1.8.2.
>>
>>- Sam
> 
> 
> I think most people work with CVS HEAD (that's 1.9).  

I not so sure that this is really the case.

Curt
Permalink | Reply | 4 comments |
headers
Marcel Molina Jr. | 10 May 2005 17:26

Re: Here to help

On Tue, May 10, 2005 at 11:18:05PM +1000, George Ogata wrote:
> James Britt <jbritt <at> ruby-doc.org> writes:
> 
> > Sam Goldman wrote:
> >> Okay, I am done with school for the summer and I'd like to help
> >> document whatever needs documenting. I was looking for a kind of
> >> "status" page on the web site but I could find none.
> >
> > There is no status page as as such, but if you look at the index page
> > for the standard library documentation [0] you'll see that some
> > library names are italicized.  These are libraries with little or no
> > documentation.  Some examples are enumerator and mathn.
> >
> >
> >> Hope I can be of some help.
> >
> >
> > Same here.  Please speak up if you have questions or problems.
> >
> > And thanks!
> >
> >
> > James Britt
> >
> >
> > [0] http://www.ruby-doc.org/stdlib/
> 
> "No status page"?  On the left frame of that very page, there's a
> "Status Report" link with some added descriptions on what needs to be
> done.  :)
(Continue reading)

Permalink | Reply | 0 comments |
headers
Mark Iler | 10 May 2005 17:31

(unknown)

unsubscribe
Permalink | Reply | 0 comments |
headers
James Britt | 10 May 2005 18:08
Favicon

Re: Here to help

Curt Hibbs wrote:
> George Ogata wrote:
> 
>> Sam Goldman <samgoldman <at> jhu.edu> writes:
>>
>>
>>> Thanks James and George.
>>>
>>> Before I start, which version(s?) of Ruby are we documenting? I'm
>>> sure this is in the web site somewhere, but I couldn't find it when I
>>> looked (perhaps in the wrong places?). I'm running 1.8.2.
>>>
>>> - Sam
>>
>>
>>
>> I think most people work with CVS HEAD (that's 1.9).  
> 
> 
> I not so sure that this is really the case.

Matz? Are you around?  Where do doc fixes/additions go?

James
Permalink | Reply | 0 comments |
headers
Ruth A. Kramer | 10 May 2005 00:10

Re: Here to help

Curt Hibbs wrote:
> George Ogata wrote:
> > Sam Goldman <samgoldman <at> jhu.edu> writes:
> >>Before I start, which version(s?) of Ruby are we documenting? I'm
> >>sure this is in the web site somewhere, but I couldn't find it when I
> >>looked (perhaps in the wrong places?). I'm running 1.8.2.
> > I think most people work with CVS HEAD (that's 1.9).
> I not so sure that this is really the case.

Well, not to make the job more complicated, but shouldn't there be
documentation for both (and maybe other versions).  Surely if there is
anything incomplete for the 1.8.2 version it should be documented. 
Documentation for CVS HEAD might be nice now, but is not as necessary as
it will be when 1.9 is released (Christmas, 2005?).

In any case, there needs to be some method to the madness, that is,
associating the documentation with a specific version of the software,
for many reasons, for example, so that someone looking for the
documentation for 1.8.2 finds it, and not the documentation for 1.9.

regards,
Randy Kramer
Permalink | Reply | 2 comments |

Gmane