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

Consider using sphinx_autodoc_typehints to avoid duplication between type hint and docstring #169

Open
ajjackson opened this issue Sep 11, 2024 · 0 comments · May be fixed by #170
Open

Consider using sphinx_autodoc_typehints to avoid duplication between type hint and docstring #169

ajjackson opened this issue Sep 11, 2024 · 0 comments · May be fixed by #170
Labels
documentation Improvements or additions to documentation

Comments

@ajjackson
Copy link
Collaborator

This came out of review for #146 . If developers are encouraged to use the autodoc documentation, I don't see any reason not to use it. The only downside is that it is sometimes convenient to use help() in interactive sessions: but this should be weighted against the risk that the docstring is incorrect.

https://github.com/tox-dev/sphinx-autodoc-typehints
@ajjackson ajjackson added the documentation Improvements or additions to documentation label Sep 11, 2024
@ajjackson ajjackson mentioned this issue Sep 11, 2024
Merged
@oerc0122 oerc0122 linked a pull request Sep 11, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add autodoc typehints; enable ruff pydocstyle oerc0122/castep_outputs
1 participant
@ajjackson