From: Dave Thomas <Dave@...>
Date: 2002-07-23T00:59:08+09:00
Subject: Re: rdtool and rdoc

Paul Brannan <pbrannan@atdesk.com> writes:

> How does RDoc handle multiple languages, though?  I think for your
> suggestion to work, it would have to make sure that there are at
> least english and japanese docs.  As Ruby grows, documenation in
> more and more languages would be wanted.  If you stick with inline
> documentation, then eventually you will end up with more
> documentation than code.

True enough. There's been some talk about having a --lang switch that
would select from available languages in the documentation, but as you
say that ends up making the files pretty messy.

I'd suggest that in any scheme there'd be a compromise: the in-source
documentation would be in a single language. hen there's be narrative
files in different languages:  README.en, README.jp, etc. Both RDTool
and RDoc can do this well (although I believe RDoc to have the
advantage in inline documentation). Also, not being able to write
Japanese, I've never had RDoc processing a multi-byte character set
file, so there may well be things that need looking at.


Cheers


Dave