Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add attribute docstrings across code base #967

Open
ns-rse opened this issue Oct 16, 2024 · 0 comments
Open

Add attribute docstrings across code base #967

ns-rse opened this issue Oct 16, 2024 · 0 comments
Labels
documentation enhancement New feature or request

Comments

@ns-rse
Copy link
Collaborator

ns-rse commented Oct 16, 2024

I noticed whilst trouble shooting the Sphinx documentation builds that the API reference has attributes listed for each class but that these do not have descriptions.

These can be added as per PEP0258 - Attribute Docstring.

We should apply these across the code base to improve our documentation for those who work on the codebase in the future (including ourselves).
@ns-rse ns-rse added enhancement New feature or request documentation labels Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ns-rse