Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document 'ruby:' to show core documentation in ri #805

Merged
merged 1 commit into from
Jul 2, 2021

Conversation

xstnztk
Copy link
Contributor

@xstnztk xstnztk commented Apr 16, 2021

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".

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".
@xstnztk
Copy link
Contributor Author

xstnztk commented Apr 16, 2021

I added this to the ri options description because I was not able to find out how to display the Ruby core documentation in ri. Only when reading the ri source code I stumbled upon the fact that 'ruby' can be used like a gem name to access the core documentation. Maybe this is obvious to other people but I am sure there are some who also do not know this.

English is not my first language, so feel free to adapt the text as you see fit.

@aycabta
Copy link
Member

aycabta commented Jun 30, 2021

Don't worry, I'm the current maintainer of RDoc but I didn't know 'gem_name:' prefix, I just know now, and I can't speak English well. I think it's probably okay, Grammaly says so too.

@zzak Is there any problem with this patch's English?

@olleolleolle
Copy link
Contributor

This PR looks good! The English reads fine and it explains the ruby: feature well.

@aycabta aycabta merged commit 0a1f102 into ruby:master Jul 2, 2021
@zzak
Copy link
Member

zzak commented Jul 4, 2021

@aycabta LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants