[DOC] StringIO doc enhancements #33
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
Member Author
| @nobu, I will merge this only after requesting your approval. Meanwhild, @peterzhu2118 and I can thrash out details? |
nobu reviewed Oct 11, 2022
| * call-seq: | ||
| * StringIO.open(string = '', mode = 'r+') {|strio| ... } | ||
| * | ||
| * Creates a new \StringIO instance formed from +string+ and +mode+; |
Member
There was a problem hiding this comment.
mode is defaulted to r if string is frozen.
Is this worth to describe?
Member Author
There was a problem hiding this comment.
Added to ::new and ::open..
ext/stringio/stringio.c Outdated
| /* | ||
| * call-seq: | ||
| * strio.string = string -> string | ||
| * string = string -> string |
| * see {Position}[https://docs.ruby-lang.org/en/master/File.html#class-File-label-Position]. | ||
| * | ||
| * Returns true if the stream is at the end of the data (underlying string). | ||
| * The stream must be opened for reading or an +IOError+ will be raised. |
Member Author
There was a problem hiding this comment.
Added (three places).
Member Author
| @nobu, I don't want to merge without your approval. |
Member Author
| @nobu, hoping for your approval. There's more I can do here once this is merged. |
Member Author
| @nobu, you're the maintainer here, right? Any further review? |
Member Author
| @nobu, let me know if you have further comments. |
matzbot pushed a commit to ruby/ruby that referenced this pull request Oct 19, 2022
(ruby/stringio#33) Treated: - ::new - ::open - #string - #string= - #close - #close_read - #close_write - #closed? - #closed_read? - #closed_write? - #eof? ruby/stringio@be9b64d739
tenderlove pushed a commit to Shopify/ruby that referenced this pull request Oct 27, 2022
(ruby/stringio#33) Treated: - ::new - ::open - #string - #string= - #close - #close_read - #close_write - #closed? - #closed_read? - #closed_write? - #eof? ruby/stringio@be9b64d739
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 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.
Treated: