Fix broken autoclass:: references on matrices/planning doc pages - #15
Merged
Merged
Conversation
Both docs/source/matrices.rst and docs/source/planning.rst referenced pgraph.PGraph.PGraph, a class that no longer exists post-rename (it's now _BaseGraph) -- and in fact never existed at that dotted path even before the rename, since the src/pgraph/ layout migration changed the real import path without these two files being updated to match (the same bug already fixed for every other doc page in the type-hints pass, but missed here). autodoc silently failed to import the class on both pages, so "Convert graph to matrix form" and "Path planning" rendered as bare headings with zero API content -- in both the HTML and PDF (verified with a real latexmk run) builds. Caught during final pre-1.0.0 review of a built PDF. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #15 +/- ##
=======================================
Coverage 85.05% 85.05%
=======================================
Files 2 2
Lines 776 776
=======================================
Hits 660 660
Misses 116 116 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Summary
Both
docs/source/matrices.rstanddocs/source/planning.rstreferencedpgraph.PGraph.PGraph, a class that no longer exists post-rename (it's now_BaseGraph) -- and in fact never existed at that dotted path even before the rename, since thesrc/pgraph/layout migration changed the real import path without these two files being updated to match (the same bug already fixed for every other doc page in the type-hints pass, but missed here).autodocsilently failed to import the class on both pages, so "Convert graph to matrix form" and "Path planning" rendered as bare headings with zero API content -- in both the HTML and PDF (verified with a reallatexmkrun, 92-page PDF) builds. Caught during final pre-1.0.0 review of a built PDF.Test plan
matrices.html/planning.htmlnow show 5/3 real method entries respectively (were 0/0)latexmk -pdfbuild succeeds; verified the generated.texfor the "Convert graph to matrix form" chapter contains the full class signature, docstrings, and executed runblock output