[#3109] Is divmod dangerous? — Dave Thomas <Dave@...>

14 messages 2000/06/06

[#3149] Retrieving the hostname and port in net/http — Roland Jesse <jesse@...>

Hi,

12 messages 2000/06/07

[#3222] Ruby coding standard? — Robert Feldt <feldt@...>

16 messages 2000/06/09

[#3277] Re: BUG or something? — Aleksi Niemel<aleksi.niemela@...>

> |I am new to Ruby and this brings up a question I have had

17 messages 2000/06/12
[#3281] Re: BUG or something? — Dave Thomas <Dave@...> 2000/06/12

Aleksi Niemel<aleksi.niemela@cinnober.com> writes:

[#3296] RE: about documentation — Aleksi Niemel<aleksi.niemela@...>

> I want to contribute to the ruby project in my spare time.

15 messages 2000/06/12

[#3407] Waffling between Python and Ruby — "Warren Postma" <embed@...>

I was looking at the Ruby editor/IDE for windows and was disappointed with

19 messages 2000/06/14

[#3410] Exercice: Translate into Ruby :-) — Jilani Khaldi <jilanik@...>

Hi All,

17 messages 2000/06/14

[#3415] Re: Waffling between Python and Ruby — Andrew Hunt <andy@...>

>Static typing..., hmm,...

11 messages 2000/06/14

[#3453] Re: Static Typing( Was: Waffling between Python and Ruby) — Andrew Hunt <andy@...>

32 messages 2000/06/16

[#3516] Deep copy? — Hugh Sasse Staff Elec Eng <hgs@...>

Given that I cannot overload =, how should I go about ensuring a deep

20 messages 2000/06/19

[#3694] Why it's quiet — hal9000@...

We are all busy learning the new language

26 messages 2000/06/29
[#3703] Re: Why it's quiet — "NAKAMURA, Hiroshi" <nahi@...> 2000/06/30

Hi,

[#3705] Re: Why it's quiet — matz@... (Yukihiro Matsumoto) 2000/06/30

Hi,

[ruby-talk:03292] about documentation

From: Wayne Scott <wscott@...>
Date: 2000-06-12 13:53:27 UTC
List: ruby-talk #3292
I want to contribute to the ruby project in my spare time.

Right now one of the biggest needs appears to be English
documentation.  I notice that Ruby has some form of embedded
documentation like Perl, but based on its use in the CGI modules it
does not appear to be the POD format.  Does documentation for this
format exist?  Have translators been written?  Any reason POD is not
being used?

Is HTML the original source for the English web pages?
(ruby-man-1.4.4.tar.gz) I would like to fix some typos, expand some
explanations and write a translator to produce a small hardcopy
reference manual.

What is the official language for Ruby documentation?  I get the
impression that things are written in Japanese first and the
translated to English.  I can't help with that. :( I also get the
impression that the Japanese version is not that much more extensive.
Is is OK that the embedded documentation in modules is in English?

One of perl's biggest strengths in its online documentation.  Using
the perldoc script you can get help for any of the included modules
(and most third party modules) and extensive help for perl itself.
Because of the POD translators you can convert that documentation to
most formats desired. (HTML, Latex, 'roff, text,...)  The only thing
that perl seems to be lacking is the ability to produce a indexed hard
copy reference manual from the man pages.  The text is all there and
in good shape, but the indexing and formating has to be done by hand.
That could all be built in from the start.  I somewhat expect this
limitation was from the fact that perl documentation was handled by
Tom Christenson and he felt that the Perl books where a better source
for a reference manual.

-Wayne


In This Thread

Prev Next