Repository navigation
docs(aggregation): Place docstring before class attributes - #819
Merged
ValerianRey merged 3 commits intoOct 7, 2026
Merged
ValerianRey merged 3 commits into
ValerianRey merged 3 commits into
Conversation
…utes _REQUIRED_DEPS and _INSTALL_HINT were defined before the docstring, so the string literal was not the class docstring and CAGradWeighting.__doc__ was None, leaving its documentation entry empty. The same issue affected the private _NashMTLWeighting. Fixes SimplexLab#807 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
SausageMan99
requested review from
a team,
KhusPatel4450,
PierreQuinton and
ValerianRey
as code owners
October 7, 2026 16:20
ValerianRey
reviewed
Oct 7, 2026
ValerianRey
added
cc: docs
ValerianRey
enabled auto-merge (squash)
October 7, 2026 16:30
ValerianRey
changed the title
github-actions
Bot
changed the title
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.
Fixes #807.
_REQUIRED_DEPSand_INSTALL_HINTwere defined before the docstring, soCAGradWeighting.__doc__wasNoneand its doc entry was empty. The attributes are now placed after the docstring (same layout asQuadprogProjector).I scanned
src/for the same pattern and found it in one other place, the private_NashMTLWeighting, which I fixed too.Added a regression test and checked that
make html -C docsbuilds and that the CAGrad page now shows the docstring.This change was prepared with the help of an AI agent (Claude) and reviewed by me before opening.