docs(aggregation): Document the __call__ method publicly#654
Open
ValerianRey wants to merge 5 commits intomainfrom
Open
docs(aggregation): Document the __call__ method publicly#654ValerianRey wants to merge 5 commits intomainfrom
ValerianRey wants to merge 5 commits intomainfrom
Conversation
ValerianRey
added
cc: docs
github-actions
bot
changed the title
ValerianRey
force-pushed
the
add-call-in-docs
branch
from
da854b9 to
ba197a9
Compare
PierreQuinton
approved these changes
Apr 17, 2026
Contributor
PierreQuinton
left a comment
PierreQuinton
left a comment
There was a problem hiding this comment.
I like this so far, I think it could be merged essentially as is, unless you want more.
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.
Why I named the class GramianWeighting instead of PSDMatrixWeighting: It's actually a kind of Weighting[PSDMatrix] acting specifically on gramians. The name gramian is even mentioned in the docstring.
I could have named MatrixWeighting as JacobianWeighting then, but the thing is that we often use MatrixWeighting for weightings that also work on the gramian. The only case where the weighting specifically needs a Jacobian is, I think, _NashMTLWeighting (which is not public btw).
We could be more rigorous, but I think it's a quite deep rabbit hole.