[ruby-core:92531] [Ruby trunk Bug#15819] cannot read document of File::NULL with ri File::NULL

[ruby-core:92531] [Ruby trunk Bug#15819] cannot read document of File::NULL with ri File::NULL

[tad.a.digger]

Issue #15819 has been reported by tad (Tadashi Saito).

----------------------------------------
Bug #15819: cannot read document of File::NULL with ri File::NULL
https://bugs.ruby-lang.org/issues/15819

* Author: tad (Tadashi Saito)
* Status: Open
* Priority: Normal
* Assignee: 
* Target version: 
* ruby -v: 
* Backport: 2.4: UNKNOWN, 2.5: UNKNOWN, 2.6: UNKNOWN
----------------------------------------




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

[ruby-core:92532] [Ruby trunk Bug#15819] cannot read document of File::NULL with "ri File::NULL"

[tad.a.digger]

Issue #15819 has been updated by tad (Tadashi Saito).

ruby -v set to ruby 2.6.3p62 (2019-04-16 revision 67580) [x86_64-linux]
Subject changed from cannot read document of File::NULL with ri File::NULL to cannot read document of File::NULL with "ri File::NULL"

When I type `ri File::NULL`, got

> Nothing known about File::NULL
> Did you mean?  File::Stat

but

* `ruby -e 'p File::NULL'` prints `"/dev/null"` succesfully
* Documents are already written in #7365
* I could read it with `ri File::File::Constants`
   * Note that `File::` needs twice like https://docs.ruby-lang.org/en/trunk/File/File/Constants.html

IHMO, it's too difficult to guess proper command.

I did not know if this was a markup mistake or a logic bug in RDoc, so I registered here for the time being.

----------------------------------------
Bug #15819: cannot read document of File::NULL with "ri File::NULL"
https://bugs.ruby-lang.org/issues/15819#change-77892

* Author: tad (Tadashi Saito)
* Status: Open
* Priority: Normal
* Assignee: 
* Target version: 
* ruby -v: ruby 2.6.3p62 (2019-04-16 revision 67580) [x86_64-linux]
* Backport: 2.4: UNKNOWN, 2.5: UNKNOWN, 2.6: UNKNOWN
----------------------------------------




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

[ruby-core:92533] [Ruby trunk Bug#15819] cannot read document of File::NULL with "ri File::NULL"

[shevegen]

Issue #15819 has been updated by shevegen (Robert A. Heiler).


> IHMO, it's too difficult to guess proper command.

Agree - File::NULL works in e. g. irb too and should work for ri. I found rdoc/ri
a bit cumbersome to use API-wise; in one project, that displays rdoc documentation
for methods (a bit similar as what pry does), I use code such as this:

    hash = RDoc::RI::Driver.process_args(arguments)
    rdoc_driver = RDoc::RI::Driver.new(hash)

To process stuff. if it were up to me I would try to enhance rdoc in general to be
more "friendly" (simpler) API-wise to use for downstream ruby users in general, but
I digress from your issue, sorry.

----------------------------------------
Bug #15819: cannot read document of File::NULL with "ri File::NULL"
https://bugs.ruby-lang.org/issues/15819#change-77893

* Author: tad (Tadashi Saito)
* Status: Open
* Priority: Normal
* Assignee: 
* Target version: 
* ruby -v: ruby 2.6.3p62 (2019-04-16 revision 67580) [x86_64-linux]
* Backport: 2.4: UNKNOWN, 2.5: UNKNOWN, 2.6: UNKNOWN
----------------------------------------




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