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

Python Coding Conventions: Clarify docstring conventions, especially for array shapes #97

Open
jchodera opened this issue Apr 12, 2022 · 1 comment
Open

Python Coding Conventions: Clarify docstring conventions, especially for array shapes #97

jchodera opened this issue Apr 12, 2022 · 1 comment
Milestone
Revision 2022.04

Comments

@jchodera
Copy link
Member

We should further clarify docstring conventions, especially for optional arguments and array shapes.

Type hints will also help with this.
@jchodera jchodera changed the title Pythjon Coding Conventions: Clarify docstring conventions, especially for array shapes Python Coding Conventions: Clarify docstring conventions, especially for array shapes Apr 12, 2022
@jchodera
Copy link
Member Author

sphinx-autodoc-typehints could auto-generate from type hints---do we want to use this?

@dotsdl dotsdl added this to the Revision 2022.04 milestone Apr 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Revision 2022.04
Development

No branches or pull requests
2 participants
@dotsdl @jchodera