Skip to content

Fix call-seq return values in C extensions#17070

Closed
zonuexe wants to merge 1 commit into
ruby:masterfrom
zonuexe:doc-call-seq-return-values
Closed

Fix call-seq return values in C extensions#17070
zonuexe wants to merge 1 commit into
ruby:masterfrom
zonuexe:doc-call-seq-return-values

Conversation

@zonuexe
Copy link
Copy Markdown
Contributor

@zonuexe zonuexe commented May 21, 2026

Some call-seq comments in C extensions did not match the actual return values. This fixes them (documentation only, no behavior change).

  • openssl: syswrite_nonblock accepts opts and can return a symbol with exception: false
  • strscan: match? returns the match size (not a position); skip was missing the -> arrow; scan_full and scan_byte can return values other than documented
  • date: Date#new_start had a stray ] in its call-seq
  • io/console: getch can return nil on EOF or timeout

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
@github-actions
Copy link
Copy Markdown

The following files are maintained in the following upstream repositories:

Please file a pull request to the above instead. Thank you!

@zonuexe zonuexe closed this May 21, 2026
@zonuexe zonuexe deleted the doc-call-seq-return-values branch May 21, 2026 11:17
@zonuexe
Copy link
Copy Markdown
Contributor Author

zonuexe commented May 21, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant