Skip to content

RubyGems Hook: add required parse-then-Store#complete to the lifecycle - #1835

Open
skatkov wants to merge 1 commit into
ruby:masterfrom
skatkov:store-complete
Open

skatkov wants to merge 1 commit into
ruby:masterfrom
skatkov:store-complete

Conversation

@skatkov

@skatkov skatkov commented Sep 26, 2026 •

Copy link
Copy Markdown
Contributor

Follow up to #1811 (comment)

#complete is ran in rubygems hooks, this sets proper filter and nocode marks.

@github-actions

github-actions Bot commented Sep 26, 2026 •

Copy link
Copy Markdown

Documentation preview

View the preview

Commit: d5ed8ea

@skatkov skatkov changed the title restores the canonical parse-then-Store#complete lifecycle RubyHooks: restores the canonical parse-then-Store#complete lifecycle Sep 26, 2026
@skatkov skatkov changed the title RubyHooks: restores the canonical parse-then-Store#complete lifecycle RubyGems Hook: restore canonical parse-then-Store#complete lifecycle Sep 26, 2026
@skatkov skatkov changed the title RubyGems Hook: restore canonical parse-then-Store#complete lifecycle RubyGems Hook: add required parse-then-Store#complete to the lifecycle Sep 26, 2026
@skatkov
skatkov marked this pull request as ready for review September 26, 2026 23:22
Copilot AI balanced review requested due to automatic review settings September 26, 2026 23:22

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

File mutations can leave the completed page index stale, returning missing or removed pages.

Review effort: Balanced
Findings: 1 Medium severity

Open (1)
What changed in this PR

Finalizes RubyGems-parsed stores and aligns page indexing with the parse-then-complete lifecycle introduced after PR #1811.

Changes:

  • Calls Store#complete from the RubyGems hook.
  • Builds page indexes during complete or load_all.
  • Updates lifecycle and cross-reference tests.
File Description
lib/​rdoc/​rubygems_hook.rb Finalizes the parsed store before generation.
lib/​rdoc/​store.rb Moves page-index construction into finalization/loading.
test/​rdoc/​rdoc_store_test.rb Updates page-index lifecycle tests.
test/​rdoc/​rdoc_rubygems_hook_test.rb Tests visibility and :nodoc: finalization.
test/​rdoc/​rdoc_cross_reference_test.rb Finalizes fixtures before page resolution.
test/​rdoc/​markup/​to_html_crossref_test.rb Finalizes cross-reference fixtures.
test/​rdoc/​generator/​markup_test.rb Finalizes generator fixtures.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread lib/rdoc/store.rb
Copilot AI review requested due to automatic review settings September 27, 2026 17:06

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

This branch has not been deployed

No deployments
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