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

Improve docstring structuring for code autocompletion. #3355

Open
tomchristie opened this issue Oct 22, 2024 · 0 comments
Open

Improve docstring structuring for code autocompletion. #3355

tomchristie opened this issue Oct 22, 2024 · 0 comments
Labels
docs Changes to the documentation

Comments

@tomchristie
Copy link
Member

  • The __init__.py module should include a docstring.
  • Should class docstrings be on the class itself or on the class __init__ method (or both?).
  • Review if we've currently got a docstring on all public API, and review consistency & styling throughout.
@tomchristie tomchristie added the docs Changes to the documentation label Oct 22, 2024
@Stealthii Stealthii mentioned this issue Oct 22, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Changes to the documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tomchristie and others