[DOC] Enhanced RDoc for StringIO #36
Merged
+24
−20
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
| @@ -1153,10 +1153,12 @@ strio_each_char(VALUE self) | |||
|
|
|||
| /* | |||
| * call-seq: | |||
| * strio.each_codepoint {|c| block } -> strio | |||
| * strio.each_codepoint -> anEnumerator | |||
| * each_codepoint {|codepoint| ... } -> self | |||
There was a problem hiding this comment.
Minor: Here, the arrow is ->.
There was a problem hiding this comment.
Fixed. (When copying from HTML, I sometimes get burned by this, and by "smart quotes.")
ext/stringio/stringio.c
Outdated
| * strio.gets(sep=$/, chomp: false) -> string or nil | ||
| * strio.gets(limit, chomp: false) -> string or nil | ||
| * strio.gets(sep, limit, chomp: false) -> string or nil | ||
| * gets(sep = $/, **line_opts) → string or nil |
There was a problem hiding this comment.
Minor: Here, and in the rest of the change, the arrow is a ligature.
I don't know which is preferred/correct.
Most welcome! |
ext/stringio/stringio.c
Outdated
Comment on lines
1371
to
1373
| * gets(sep = $/, **line_opts) -> string or nil | ||
| * gets(limit, **line_opts) -> string or nil | ||
| * gets(sep, limit, **line_opts) -> string or nil |
There was a problem hiding this comment.
It looks like the only keyword argument that these method accept is chomp:, so I think it's clearer to explicitly state that rather than having a generic **line_opts.
| * Calls the block with each remaining line read from the stream; | ||
| * does nothing if already at end-of-file; | ||
| * returns +self+. | ||
| * See {Line IO}[https://docs.ruby-lang.org/en/master/io_streams_rdoc.html#label-Line+IO]. |
There was a problem hiding this comment.
I think we should mention that each is an alias of each_line.
matzbot
pushed a commit
to ruby/ruby
that referenced
this pull request
Oct 21, 2022
(ruby/stringio#36) Treats: - #each_codepoint - #gets - #readline (shows up in doc for module IO::generic_readable, not class StringIO) - #each_line ruby/stringio@659aca7fe5
tenderlove
pushed a commit
to Shopify/ruby
that referenced
this pull request
Oct 27, 2022
(ruby/stringio#36) Treats: - #each_codepoint - #gets - #readline (shows up in doc for module IO::generic_readable, not class StringIO) - #each_line ruby/stringio@659aca7fe5
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.
Treats: