Skip to content

Hide embedded Racc runtime from generated API docs - #1799

Merged
st0012 merged 3 commits into
ruby:masterfrom
OskarEichler:songstats/hide-racc-runtime-docs
Aug 31, 2026
Merged

Hide embedded Racc runtime from generated API docs#1799
st0012 merged 3 commits into
ruby:masterfrom
OskarEichler:songstats/hide-racc-runtime-docs

Conversation

@OskarEichler

@OskarEichler OskarEichler commented Aug 30, 2026

Copy link
Copy Markdown
Contributor

Summary

Exclude the two generated RD parser implementations from RDoc input through .rdoc_options.

This keeps the generated parser files and generator untouched while preventing their embedded Racc runtime internals from appearing in the public API documentation.

Fixes #1762.

Verification

  • full RDoc dry-run completes successfully;
  • the final diff contains only the two .rdoc_options exclusions;
  • parser runtime code and generated files are unchanged.

@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?

@OskarEichler

Copy link
Copy Markdown
Contributor Author

Updated as requested: the generated parser files and generator are untouched now, and both generated RD parsers are excluded in .rdoc_options. I also merged current master; the PR diff is now only those two exclude entries. A full dry-run documentation build completes successfully.

@OskarEichler
OskarEichler deployed to fork-preview-protection August 31, 2026 09:51 — with GitHub Actions Active
@matzbot

matzbot commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator

🚀 Preview deployment available at: https://e25f521c.rdoc-6cd.pages.dev (commit: a8ede16)

@st0012

st0012 commented Aug 31, 2026

Copy link
Copy Markdown
Member

Can you please update the PR description too?

@OskarEichler

Copy link
Copy Markdown
Contributor Author

Updated the PR description so it now reflects the final .rdoc_options-only implementation and its verification. Thanks for the reminder.

@st0012

st0012 commented Aug 31, 2026

Copy link
Copy Markdown
Member

Thanks for the PR 👍

@st0012
st0012 merged commit d2107e0 into ruby:master Aug 31, 2026
30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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

3 participants