Skip to content

Update docs/inline.md to match current inline parser behavior#2953

Merged
soutaro merged 1 commit into
ruby:masterfrom
ksss:update-inline-docs
May 14, 2026
Merged

Update docs/inline.md to match current inline parser behavior#2953
soutaro merged 1 commit into
ruby:masterfrom
ksss:update-inline-docs

Conversation

@ksss
Copy link
Copy Markdown
Collaborator

@ksss ksss commented May 13, 2026

Comparing lib/rbs/inline_parser.rb against docs/inline.md surfaced several
items that were stale or missing in the documentation:

  • Removed outdated method limitations (singleton methods and splat/block
    parameters were already supported).
  • Added a note that singleton methods (def self.NAME) are supported, with
    an example in the Method Definitions intro.
  • Documented the trailing #: annotation for method return types.
  • Fixed constant type inference: a bare symbol literal infers to Symbol,
    not the singleton symbol type; also added nil to the inferred list.
  • Added a Skip Annotation section for @rbs skip, which was previously
    undocumented despite being a first-class feature.
  • Added limitations: class << self, top-level def, non-self receiver
    (def obj.foo), top-level attr_*.
  • Fixed two typos: "hyphones" → "hyphens", "infered" → "inferred".

🤖 Generated with Claude Code

- Remove outdated method limitations (singleton methods, splat/block params)
- Add note that singleton methods (`def self.NAME`) are supported
- Document trailing `#:` annotation for method return types
- Fix constant type inference: Symbol literals infer to `Symbol`, not the
  singleton symbol type; add `nil` to the list
- Add Skip Annotation section for `@rbs skip`
- Add limitations: `class << self`, top-level def, non-self receiver,
  top-level attr_*
- Fix typos: "hyphones" -> "hyphens", "infered" -> "inferred"

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@ksss ksss added this to the RBS 4.1 milestone May 13, 2026
Copy link
Copy Markdown
Member

@soutaro soutaro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙏

@soutaro soutaro merged commit 9c502bd into ruby:master May 14, 2026
24 of 26 checks passed
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.

2 participants