Documentation improvements for Ruby core [ci skip] #2612
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Top-level `return`; * Documentation for comments syntax; * `rescue` inside blocks; * Enhance `Object#to_enum` docs; * Make `chomp:` option more obvious for `String#each_line` and `#lines`; * Enhance `Proc#>>` and `#<<` docs; * Enhance `Processs` class docs.
|
It might be better to split into separate commits per items. |
zverok
added a commit
to zverok/ruby
that referenced
this pull request
Dec 22, 2019
In ruby#2612 I made two typos (extra ,, and copy-pasted same line of code instead of showing two different ones), fixing them.
nobu
pushed a commit
that referenced
this pull request
Dec 22, 2019
In #2612 I made two typos (extra ,, and copy-pasted same line of code instead of showing two different ones), fixing them.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains several improvements for Ruby core language/core classes docs (I can split it in several, if it is necessary). In particular:
returnin keywords.rdoc;rescueinside blocks in exceptioins.rdoc;Object#to_enumdocs with more explanation and examples;chomp:option more obvious forString#each_lineand#lines(previously this only option, to be discovered, required reader to travel through links and read deep into other classes documentation);Proc#>>and#<<docs with explanations about arguments;Processgeneral docs with some explanation of module's goals.Probably language should be checked (I am not native).