Fix call-seq return values in C extensions#17070
Closed
zonuexe wants to merge 1 commit into
Closed
Conversation
Several call-seq comments did not match the actual return values: * openssl: syswrite_nonblock accepts opts and can return a symbol * strscan: match? returns the match size, not a position; skip was missing the `->` arrow; scan_full and scan_byte can return other values than documented * date: Date#new_start had a stray `]` in call-seq * io/console: getch can return nil on EOF or timeout
|
The following files are maintained in the following upstream repositories:
Please file a pull request to the above instead. Thank you! |
Contributor
Author
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
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.
Some
call-seqcomments in C extensions did not match the actual return values. This fixes them (documentation only, no behavior change).syswrite_nonblockacceptsoptsand can return a symbol withexception: falsematch?returns the match size (not a position);skipwas missing the->arrow;scan_fullandscan_bytecan return values other than documentedDate#new_starthad a stray]in its call-seqgetchcan returnnilon EOF or timeout