physicsnemo
physicsnemo copied to clipboard
📚[DOC]: Use consistent doc strings format across the repo
How would you describe the priority of this documentation request
Critical (currently preventing usage)
Is this for new documentation, or an update to existing docs?
New
Describe the incorrect/future/missing documentation
We should use consistent, numpy-style for the docstrings. Presently, there is some code which uses the google style.
Do you have a pre-commit hook in mind to enforce this? I think this is an excellent idea.