[DOC] Fix grammar errors, typos, and improve readability of string.rb #12151
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
st0012
commented
Nov 22, 2024
| # | ||
| # - A first argument, +pattern+ (string or regexp), | ||
| # that specifies the substring(s) to be replaced. | ||
| # - A first argument, +pattern+ (String or Regexp), |
There was a problem hiding this comment.
Capitalizing changes like this will make them link to the relevant classes, which is an improvement IMO.
| # - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here]. | ||
| # - Includes {module Comparable}[rdoc-ref:Comparable@What-27s+Here]. | ||
| # - Inherits the {Object class}[rdoc-ref:Object@What-27s+Here]. | ||
| # - Includes the {Comparable module}[rdoc-ref:Comparable@What-27s+Here]. |
There was a problem hiding this comment.
FWIW, if in the future we can enable the --embed-mixins flag added by @flavorjones in ruby/ruby, these methods will be added to the String class's doc directly.
| # - #chomp: Returns a copy of +self+ with a trailing record separator removed, if found. | ||
| # - #chop: Returns a copy of +self+ with trailing newline characters or the last character removed. | ||
| # - #squeeze: Returns a copy of +self+ with contiguous duplicate characters removed. | ||
| # - #[] (aliased as #slice): Returns a substring determined by a given index, start/length, range, regexp, or string. |
There was a problem hiding this comment.
I think it takes regexp too so I just added it:
irb(main):001> s = "foobar"
=> "foobar"
irb(main):002> s[/foo/]
=> "foo"
|
@jeremyevans @peterzhu2118 would you mind giving this a look? Thx |
jeremyevans
approved these changes
Dec 11, 2024
|
@jeremyevans Thanks for the suggestions! |
st0012
force-pushed
the
improve-string-rb-documentation
branch
from
7de8da9 to
38f487d
Compare
Because this file's comments have one extra space after the `#` sign, almost every line is updated. IMO, it's better to address this issue in one go.
st0012
force-pushed
the
improve-string-rb-documentation
branch
from
38f487d to
81be59e
Compare
jeremyevans
approved these changes
Dec 14, 2024
Co-authored-by: Jeremy Evans <[email protected]>
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.
Because this file's comments have one extra space after the
#sign, almost every line is updated. IMO, it's better to address this issue in one go.To ignore the whitespace changes, please use this link for review.