software-development icon indicating copy to clipboard operation
software-development copied to clipboard
verified publisher icon choderalab

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

Open jchodera opened this issue 3 years ago • 1 comments

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

Type hints will also help with this.

jchodera avatar Apr 12 '22 18:04 jchodera

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

jchodera avatar Apr 12 '22 18:04 jchodera