Enhanced RDoc for IO #5367
Merged
Enhanced RDoc for IO #5367
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
marivaldo
reviewed
Dec 29, 2021
io.c
Outdated
Comment on lines
4028
to
4030
| * f.gets(chomp: true)# => "" | ||
| * f.gets(chomp: true) # => "Fourth line" | ||
| * f.gets(chomp: true) # => "Fifth line" |
There was a problem hiding this comment.
Suggested change
| * f.gets(chomp: true)# => "" | |
| * f.gets(chomp: true) # => "Fourth line" | |
| * f.gets(chomp: true) # => "Fifth line" | |
| * f.gets(chomp: true) # => "" | |
| * f.gets(chomp: true) # => "Fourth line" | |
| * f.gets(chomp: true) # => "Fifth line" |
marivaldo
reviewed
Dec 29, 2021
io.c
Outdated
| @@ -3461,19 +3460,19 @@ io_write_nonblock(rb_execution_context_t *ec, VALUE io, VALUE str, VALUE ex) | |||
| * When argument +out_string+ is given, | |||
| * the returned value is +out_string+, whose content is replaced: | |||
| * | |||
| * f = File.new('t.txt') | |||
| * f = File.ne w('t.txt') | |||
There was a problem hiding this comment.
Suggested change
| * f = File.ne w('t.txt') | |
| * f = File.new('t.txt') |
marivaldo
reviewed
Dec 29, 2021
io.c
Outdated
Comment on lines
3998
to
4001
| * f.gets('l') # => "First l" | ||
| * f.gets('li') # => "ine\nSecond li" | ||
| * f.gets('lin') # => "ne\n\nFourth lin" | ||
| * f.gets # => "e\n" |
There was a problem hiding this comment.
Suggested change
| * f.gets('l') # => "First l" | |
| * f.gets('li') # => "ine\nSecond li" | |
| * f.gets('lin') # => "ne\n\nFourth lin" | |
| * f.gets # => "e\n" | |
| * f.gets('l') # => "First l" | |
| * f.gets('li') # => "ine\nSecond li" | |
| * f.gets('lin') # => "ne\n\nFourth lin" | |
| * f.gets # => "e\n" |
marivaldo
reviewed
Dec 29, 2021
io.c
Outdated
Comment on lines
13972
to
13975
| * f.gets('l') # => "First l" | ||
| * f.gets('li') # => "ine\nSecond li" | ||
| * f.gets('lin') # => "ne\n\nFourth lin" | ||
| * f.gets # => "e\n" |
There was a problem hiding this comment.
Suggested change
| * f.gets('l') # => "First l" | |
| * f.gets('li') # => "ine\nSecond li" | |
| * f.gets('lin') # => "ne\n\nFourth lin" | |
| * f.gets # => "e\n" | |
| * f.gets('l') # => "First l" | |
| * f.gets('li') # => "ine\nSecond li" | |
| * f.gets('lin') # => "ne\n\nFourth lin" | |
| * f.gets # => "e\n" |
io.c
Outdated
| * | ||
| * There are two special line separators: | ||
| * | ||
| * - +nil+: The entire stream is read into a single string: |
There was a problem hiding this comment.
Suggested change
| * - +nil+: The entire stream is read into a single string: | |
| * - +nil+: The entire stream is read into a single string: |
jeremyevans
requested changes
Dec 30, 2021
| * | ||
| * These methods include: | ||
| * | ||
| * - IO::foreach. |
There was a problem hiding this comment.
Seems odd to use periods after each of these entries. However, that's just an observation, so if you think periods should be used, I'm fine with that.
There was a problem hiding this comment.
I like the periods.
io.c
Outdated
| * | ||
| * - Returns the next line as determined by line separator +sep+, | ||
| * or +nil+ if none. | ||
| * - But returns no more than <tt>limit+1</tt> bytes. |
There was a problem hiding this comment.
This doesn't appear to be correct for multibyte IO:
File.binwrite("t.t", "\u{10000}".b) # => 4
File.open('t.t', "r:UTF-8"){|f| f.gets("\n", 1).bytesize} #=> 4The actual value is probably limit + maximum bytesize of single character in encoding - 1 (limit+3 for UTF-8, I'm not sure about other encodings). Not sure if there is a succinct way of stating that.
There was a problem hiding this comment.
Part of limit discussion recast.
jeremyevans
approved these changes
Dec 30, 2021
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.
Adds sections to class RDoc:
Revises example text file
t.txtto:Revises examples that use the changed example file.
There are several other methods that will point to the added sections.