Doc: add Attributes section#700
Merged
Merged
Conversation
Collaborator
Author
|
@cako this was long overdue and with some help with Copilot it took less than expected (I run out of the autocompletion allowance this months ahah). I am not expecting you to look at this line by line, but let me know if you have any general suggestion 😄 |
cako
approved these changes
Oct 22, 2025
Collaborator
cako
left a comment
There was a problem hiding this comment.
This is amazing!! Huge effort but will result in much better docs!! Thanks
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
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 #488.
This PR aims to update all Attributes sections of the docstrings of operators and solvers, including all of the internal attributes that we want users/devs to be aware of (previously we simply reported shape/explicit and missed many useful ones) - note that Parameters that are saved as class members are not added to the Attributes list, only new class members are.
Moreover, since the
Attributessections are now meaningful we make them appear in the Sphinx documentation.Additional:
_*). Ideally I would have like to be more aggressive but I was worried about breaking backward compatibility for some attributes that users may print or check so I decided to be very conservative.np.ndarrayin docstrings have been switched tonumpy.ndarrayto be able to have hyperlinks pointing to the NumPy documentation.funcin the documentation are turned into :obj:callable