[ruby-core:83224] [Ruby trunk Bug#14004] ri confused by method aliases and by Queue versus Thread::Queue

Issue #14004 has been updated by kernigh (George Koehler).


I run `make html` in my build of Ruby trunk.
This puts the HTML in .ext/html,
so I run `firefox .ext/html/index.html` to view it.

I can confirm that the HTML docs do understand most aliases. For example, Array#append says, *Alias for: push*, in italic; and #push lists #append as an alias. So it seems that the HTML can handle aliases, but ri can't handle them. Bug in ri?

The HTML still doesn't understand that Queue and Thread::Queue are the same. The class document is under Queue and the method documents are under Thread::Queue. This is the same problem as ri.

Array#collect and Array#map have copies of the same doc, because the C code (in array.c) defines both methods using rb_define_method().

```c
    rb_define_method(rb_cArray, "collect", rb_ary_collect, 0);
...
    rb_define_method(rb_cArray, "map", rb_ary_collect, 0);
```

This is different from Array#append or Array#prepend, where the C code uses rb_define_alias().

```c
    rb_define_method(rb_cArray, "push", rb_ary_push_m, -1);
    rb_define_alias(rb_cArray,  "append", "push");
...
    rb_define_method(rb_cArray, "unshift", rb_ary_unshift_m, -1);
    rb_define_alias(rb_cArray,  "prepend", "unshift");
```
```

----------------------------------------
Bug #14004: ri confused by method aliases and by Queue versus Thread::Queue
https://bugs.ruby-lang.org/issues/14004#change-67173

* Author: kernigh (George Koehler)
* Status: Open
* Priority: Normal
* Assignee: 
* Target version: 
* ruby -v: ruby 2.5.0dev (2017-10-10 trunk 60155) [x86_64-openbsd6.2]
* Backport: 2.3: UNKNOWN, 2.4: UNKNOWN
----------------------------------------
`ri` in Ruby trunk fails to find documentation for some methods.

Array#append and Array#prepend are new in trunk. ri knows that these methods exist, but has no document for them.

```
$ ri Array#append

= Array#append

(from ruby core)
------------------------------------------------------------------------------
  append(*args)

------------------------------------------------------------------------------
```

The same problem happens with all methods from `rb_define_alias()` in Ruby's source code. For example, Array#size, IO#to_i, Hash#to_s, and Thread#inspect have no document. These are all aliases of other methods that have document.

There is another problem with Queue, an alias for Thread::Queue. ri doesn't know that Queue has methods.

```
$ ri Queue#push
Nothing known about Queue#push
```

The command `ri Queue` shows the document for the class, but it has no methods. The command `ri Thread::Queue` shows methods, but no class document. The same problem happens with other classes in rthread_sync.c, like Mutex.



-- 
https://bugs.ruby-lang.org/

Unsubscribe: <mailto:[e-mail]?subject=unsubscribe>
<http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-core>