[DOC] Tweaks for StringIO#getc #189
Merged
Conversation
This file contains hidden or 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
kou
reviewed
Dec 6, 2025
doc/stringio/getc.rdoc
Outdated
| strio.getc # => "\x93" | ||
|
|
||
| Related: StringIO.getbyte. | ||
| Related: #each_char, #putc, #ungetc. |
Member
There was a problem hiding this comment.
Why is getbyte removed from related methods?
Member
Author
There was a problem hiding this comment.
Why is
getbyteremoved from related methods?
The Ruby doc guide suggests no more than three relateds (though of course that doc does not govern here). I thought the three other char methods more important than the byte method.
Member
There was a problem hiding this comment.
Oh, I didn't know the guide.
I think that #getbyte (similar), #ungetc (opposite) and #putc (opposite) are most related 3 methods because they focus on one operation like #getc does. #each_char (iterator variant) is less related than them because it focus on multiple targets.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.