Newbie question about Ri

I just installed the latest Windows version from Activestate (having
completely removed earlier version) ruby186-25.exe and that is working
fine:
C:\ruby\bin>ruby -v
ruby 1.8.6 (2007-03-13 patchlevel 0) [i386-mswin32]

however when I came to work through tutorials I found Ri wasn’t
working quite as I expected:

C:\ruby\bin>ri String#tr

String#tr
tr(from, to)

 (no description...)

according to the tutorial I should get a lot more info about
parameters, example of usage etc. from last time I played with this I
thought it was more informative, have I missed an important step in
the installation?

Grehom wrote:


Nope, you did nothing wrong. At least, that’s the same output I get (on
Linux, having installed Ruby from a package manager). The fact that it
even shows up means it’s working. Otherwise it would say “Nothing known
about String#tr”. Other methods will have better documentation.

Thanks for quick response, I’ve found other functions seem to be
working ok, for example ri String#unpack, produced what my Pickaxe
book tells me about. But I did wonder where someone without the book
would get documentation on that function.

Grehom wrote:

Thanks for quick response, I’ve found other functions seem to be
working ok, for example ri String#unpack, produced what my Pickaxe
book tells me about. But I did wonder where someone without the book
would get documentation on that function.

I love Ruby. And Rails. But I’ve found the lack of documentation to be
its weakest link. Big time. I’m a newbie and have asked other veterans
about this - and they all agree.

Larry Hannay wrote, On 6/11/2007 6:30 AM:

What specifically have you found missing?

Hi –

On Fri, 8 Jun 2007, Grehom wrote:


String#tr
tr(from, to)

(no description...)

according to the tutorial I should get a lot more info about
parameters, example of usage etc. from last time I played with this I
thought it was more informative, have I missed an important step in
the installation?

No; I’m seeing the same problem. For some reason tr isn’t getting
picked up during rdoc/ri generation.

David

On 6/11/07, [email protected] [email protected] wrote:

however when I came to work through tutorials I found Ri wasn’t
parameters, example of usage etc. from last time I played with this I
thought it was more informative, have I missed an important step in
the installation?

No; I’m seeing the same problem. For some reason tr isn’t getting
picked up during rdoc/ri generation.

The reason is that rdoc picks empty docs from lib/jcode.rb.
Maybe we should add #:nodoc: to some of the methods in jcode.rb

J.

On 6/11/07, Jano S. [email protected] wrote:

The reason is that rdoc picks empty docs from lib/jcode.rb.
Maybe we should add #:nodoc: to some of the methods in jcode.rb

I have filed patch that fixes the issue:

http://rubyforge.org/tracker/index.php?func=detail&aid=11504&group_id=426&atid=1700

J.

Grehom wrote:

Thanks for quick response, I’ve found other functions seem to be
working ok, for example ri String#unpack, produced what my Pickaxe
book tells me about. But I did wonder where someone without the book
would get documentation on that function.

http://ruby-doc.org/


James B.

“A principle or axiom is of no value without the rules for applying it.”

  • Len Bullard

On 6/11/07, Phrogz [email protected] wrote:

RDoc, and hence also has broken/missing information on String#tr
Somehow ruby-doc.org has both definitions, empty tr and correct
str.tr. RI picks the first.

On Jun 11, 12:54 pm, “Jano S.” [email protected] wrote:

On 6/11/07, Phrogz [email protected] wrote:

…except that in the OP’s problem, ruby-doc gets its information from
RDoc, and hence also has broken/missing information on String#tr

Somehow ruby-doc.org has both definitions, empty tr and correct
str.tr. RI picks the first.

Oops, mea culpa. I saw the empty definition and missed the full one. :slight_smile:

On 11 Jun, 16:02, “Jano S.” [email protected] wrote:

On 6/11/07, Jano S. [email protected] wrote:

The reason is that rdoc picks empty docs from lib/jcode.rb.
Maybe we should add #:nodoc: to some of the methods in jcode.rb

I have filed patch that fixes the issue:

http://rubyforge.org/tracker/index.php?func=detail&aid=11504&group_id

J.

That’s great thanks, I know other beginners like me will appreciate it.

On Jun 11, 10:48 am, James B. [email protected] wrote:

Grehom wrote:

Thanks for quick response, I’ve found other functions seem to be
working ok, for example ri String#unpack, produced what my Pickaxe
book tells me about. But I did wonder where someone without the book
would get documentation on that function.

http://ruby-doc.org/

…except that in the OP’s problem, ruby-doc gets its information from
RDoc, and hence also has broken/missing information on String#tr

This forum is not affiliated to the Ruby language, Ruby on Rails framework, nor any Ruby applications discussed here.

| Privacy Policy | Terms of Service | Remote Ruby Jobs