search

choderalab / software-development

A primer on software development best practices for computational chemistry
254 stars 76 forks source link

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

Open jchodera opened 2 years ago

jchodera commented 2 years ago

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

Type hints will also help with this.

jchodera commented 2 years ago

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