Skip to content

Document why core signatures leave out methods defined only under -n/-p #3219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zonuexe wants to merge 1 commit into
base: master
Choose a base branch
from
+6 −0
Open

Document why core signatures leave out methods defined only under -n/-p #3219

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,9 @@ Use `void` when callers should ignore or discard the return value. Use `untyped`
### How do we avoid duplicate documentation when importing RDoc?

When an extension library extends a core class (such as `time` extending `Time` or `random-formatter` extending `Random::Formatter`), `rbs annotate` can duplicate core class documentation. Add `%a{annotate:rdoc:skip}` to the module or class declaration to skip the duplicate docs.

### Why don't the core signatures declare `Kernel?.gsub` and the other `-n`/`-p` methods?

Ruby defines the module functions `Kernel?.sub`, `Kernel?.gsub`, `Kernel?.chop` and `Kernel?.chomp` only when it runs with `-n` or `-p`, for Perl-style one-liners.
In an ordinary script these methods don't exist, so a declaration would let type checkers accept calls that raise `NoMethodError`.
RBS leaves them out, along with other methods that only an interpreter option defines.
Loading