How can I contribute to the ruby docs

ruby-talk
1

I have been directed toward this link: http://documenting-ruby.org/>

But is seems outdated.

Is there any alternative guide for contributing to the docs?

2

Quoting Francois Buys (buys.fran@gmail.com):

   I have been directed toward this link: [1]http://documenting-ruby.org
   But is seems outdated.
   Is there any alternative guide for contributing to the docs?

I believe you can submit patches to the main git repo:

This is where the bulk of development work takes place.

Carlo

···

Subject: How can I contribute to the ruby docs
  Date: Mon 28 Mar 22 03:02:24PM +0200

--
  * Se la Strada e la sua Virtu' non fossero state messe da parte,
* K * Carlo E. Prelz - fluido@fluido.as che bisogno ci sarebbe
  * di parlare tanto di amore e di rettitudine? (Chuang-Tzu)

3

Thank you for answering.

I don’t know where to start, could you give me any guidance?

I am looking at the documentation over here: Class: Integer (Ruby 3.1.1)

And it seems like there is a mistake I would like to fix.
Integer does not include Enumerable, but is is shown as included.

···

On 28 Mar 2022, at 15:08, Carlo E. Prelz <fluido@fluido.as> wrote:

  Subject: How can I contribute to the ruby docs
  Date: Mon 28 Mar 22 03:02:24PM +0200

Quoting Francois Buys (buys.fran@gmail.com):

  I have been directed toward this link: [1]http://documenting-ruby.org
  But is seems outdated.
  Is there any alternative guide for contributing to the docs?

I believe you can submit patches to the main git repo:

GitHub - ruby/ruby: The Ruby Programming Language

This is where the bulk of development work takes place.

Carlo

--
* Se la Strada e la sua Virtu' non fossero state messe da parte,
* K * Carlo E. Prelz - fluido@fluido.as che bisogno ci sarebbe
* di parlare tanto di amore e di rettitudine? (Chuang-Tzu)

Unsubscribe: <mailto:ruby-talk-request@ruby-lang.org?subject=unsubscribe>
<http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-talk&gt;

PastedGraphic-1.png

4

Quoting Francois Buys (buys.fran@gmail.com):

I don’t know where to start, could you give me any guidance?

I am looking at the documentation over here:
Class: Integer (Ruby 3.1.1)
<https://ruby-doc.org/core-3.1.1/Integer.html&gt;

If you look at the home page of ruby-doc.org, you will read:

--8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<--
See a bug or omission in the API docs?

Visit http://documenting-ruby.org
--8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<--

I suggest you visit that site. I myself am not familiar with it.

Best

Carlo

···

Subject: Re: How can I contribute to the ruby docs
  Date: Mon 28 Mar 22 03:41:25PM +0200

--
  * Se la Strada e la sua Virtu' non fossero state messe da parte,
* K * Carlo E. Prelz - fluido@fluido.as che bisogno ci sarebbe
  * di parlare tanto di amore e di rettitudine? (Chuang-Tzu)

5

There's nothing wrong with the documentation source (which in this case is generated from the ruby source directly, from numeric.c). It doesn't list Integer as including Enumerable. You can see this by looking at `ri Integer` (and then `ri Numeric` where you can see it includes Comparable).

ruby-doc.org is NOT the official ruby documentation. It's just a website that James Britt created and hosts. It isn't canonical, it just appears that way because of google. So fixing something in the ruby doc source won't change anything on that site (because, in this case, there's nothing to fix).

···

On Mar 28, 2022, at 06:41, Francois Buys <buys.fran@gmail.com> wrote:

Thank you for answering.

I don’t know where to start, could you give me any guidance?