Finish documentation for Heuristic module#10
Merged
Luis-Varona merged 1 commit intomainfrom Jun 11, 2025
Merged
Conversation
Finish all docstrings (including doctests and examples) for the Heuristic module, along with several References. Modify the overall formatting and design within src/ to be consistent with this. Also change the Documenter website accordingly. Note that documentation of some core MatrixBandwidth names themselves (e.g., minimize_bandwidth) is yet to be completed.
Luis-Varona
force-pushed
the
heuristic-docs
branch
from
0007852 to
83e57f9
Compare
|
Codecov ReportAttention: Patch coverage is
📢 Thoughts on this report? Let us know! |
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
2 participants
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.
Finish all docstrings (including doctests and examples) for the
Heuristicmodule, along with several References. Modify the overall formatting and design withinsrc/to be consistent with this.Note that documentation of some core
MatrixBandwidthnames themselves (e.g.,minimize_bandwidth) is yet to be completed.Given that logic, documentation, and tests are now all done for both
CuthillMcKeeandReverseCuthillMcKee, this PR completes the Heuristic section of issue #4.