doc: add docstrings to the result anlysis methods for sparse matrix preparations#984
Merged
gdalle merged 2 commits intoJuliaDiff:mainfrom Apr 1, 2026
Merged
doc: add docstrings to the result anlysis methods for sparse matrix preparations#984gdalle merged 2 commits intoJuliaDiff:mainfrom
gdalle merged 2 commits intoJuliaDiff:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #984 +/- ##
=======================================
Coverage 98.20% 98.20%
=======================================
Files 135 135
Lines 8000 8000
=======================================
Hits 7856 7856
Misses 144 144
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
Author
|
I do not understand the failing test related to |
Contributor
Author
|
Oopsie, I clicked close by mistake. Now all the CI need to run again 🥲 |
gdalle
approved these changes
Apr 1, 2026
Member
gdalle
left a comment
gdalle
left a comment
There was a problem hiding this comment.
thanks! I'll re-run the formatter and merge
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.
Closes #981
This PR add docstrings to the methods :
SMC.sparsity_pattern(prep::DI.SparseJacobianPrep)SMC.column_colors(prep::DI.SparseJacobianPrep)SMC.column_groups(prep::DI.SparseJacobianPrep)SMC.row_colors(prep::DI.SparseJacobianPrep)SMC.row_groups(prep::DI.SparseJacobianPrep)SMC.ncolors(prep::DI.SparseJacobianPrep)SMC.sparsity_pattern(prep::DI.SparseHessianPrep)SMC.column_colors(prep::DI.SparseHessianPrep)SMC.column_groups(prep::DI.SparseHessianPrep)SMC.ncolors(prep::DI.SparseHessianPrep)Having them documented send a signal that the methods can be safely used publicly.