kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

[ruby/rdoc] Document 'ruby:' to show core documentation in ri

Browse source 
ri supports 'ruby:' as a kind of "pseudo gem name" to display files of the core Ruby documentation such as syntax and NEWS. Add the appropriate documentation to the description of options shown by "ri --help".

https://github.com/ruby/rdoc/commit/a0e5df6702
This commit is contained in:
xstnztk 2021-04-16 13:42:23 +02:00 committed by Nobuyoshi Nakada
parent cca2f7ab14
commit c7d1989986
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
lib/rdoc/ri/driver.rb
View file

@ -142,6 +142,8 @@ Where name can be:
gem_name: | gem_name:README | gem_name:History
ruby: | ruby:NEWS | ruby:globals
All class names may be abbreviated to their minimum unambiguous form.
If a name is ambiguous, all valid options will be listed.
@ -153,6 +155,10 @@ they're contained in. If the gem name is followed by a ':' all files in the
gem will be shown. The file name extension may be omitted where it is
unambiguous.
'ruby' can be used as a pseudo gem name to display files from the Ruby
core documentation. Use 'ruby:' by itself to get a list of all available
core documentation files.
For example:
#{opt.program_name} Fil
@ -160,6 +166,7 @@ For example:
#{opt.program_name} File.new
#{opt.program_name} zip
#{opt.program_name} rdoc:README
#{opt.program_name} ruby:comments
Note that shell quoting or escaping may be required for method names
containing punctuation: