docs: propagate the get_parkinson_vol rename into the docs - #25
Merged
Conversation
Merging the rename (#24) alongside the docs stack left main inconsistent: the Rust symbol was renamed but moduleDocs.ts, the generated util-volatility page and apiInventory.ts still referenced the old spelling, so check:examples and check:api-drift both failed on main. Updated the three references in moduleDocs.ts, regenerated the module pages and regenerated the API inventory. This is exactly the failure the new check:examples gate exists to catch, and it caught it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes a red
main.Merging the rename (#24) alongside the docs stack left
maininternally inconsistent: the Rustsymbol was renamed to
get_parkinson_vol, butmoduleDocs.ts, the generatedmodules/util-volatility.mdandapiInventory.tsstill referencedget_parksinson_vol. Socheck:examplesandcheck:api-driftboth failed onmain— a documented example calling asymbol that no longer exists.
This was a known, tracked consequence of the merge order: the rename branch carried the pre-#18 page
generator, so regenerating from it would have reverted the honest-status work.
What changed
docs-site/src/data/moduleDocs.tsdocs-site/src/data/apiInventory.tsVerification — all five gates
astro build0 ·check-content-schema0 ·check-links0 ·check:examples0 (39 examples across33 pages) ·
check:api-drift0Worth noting: this is precisely the failure
check:exampleswas built for, and it caught it.