Skip to content

Hide embedded Racc runtime from generated API docs - #1799

Open
OskarEichler wants to merge 1 commit into
ruby:masterfrom
OskarEichler:songstats/hide-racc-runtime-docs
Open

Hide embedded Racc runtime from generated API docs#1799
OskarEichler wants to merge 1 commit into
ruby:masterfrom
OskarEichler:songstats/hide-racc-runtime-docs

Conversation

@OskarEichler

Copy link
Copy Markdown

Summary

Wrap the Racc runtime embedded in the generated RD parsers with :stopdoc: / :startdoc: markers, and teach the generator to reproduce those markers.

This keeps the generated RDoc::RD API while excluding the bundled parser-runtime implementation from RDoc output.

Fixes #1762.

Verification

  • generated parser files reproduce cleanly;
  • complete suite: 2,529 tests / 6,181 assertions on Ruby 3.2 and 4.0;
  • RubyGems integration: 20 tests / 46 assertions;
  • full self-documentation generation and focused documentation model;
  • 209-file RuboCop, CSS/template lint and syntax checks.

No test files were changed. Parser runtime behavior is unchanged; only generated documentation visibility changes.

@st0012

st0012 commented Aug 30, 2026

Copy link
Copy Markdown
Member

We shouldn't update generated docs this way. Can we exclude them in .rdoc_options instead?

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.

Embedded Racc runtime is exposed as part of RDoc's generated API documentation

2 participants