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.

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

Reformat all docstrings to numpydoc style #327

Open
jvavrek opened this issue Mar 28, 2022 · 2 comments
Open

Reformat all docstrings to numpydoc style #327

jvavrek opened this issue Mar 28, 2022 · 2 comments

Comments

@jvavrek
Copy link
Contributor

jvavrek commented Mar 28, 2022

Files such as isotope_qty.py still use an older docstring style. My VSCode sees this and uses 2 spaces per tab instead of the standard 4. We should update the older files to use the numpydoc style, and @micahfolsom optionally check this automatically e.g. with pre-commit.

@jvavrek
Copy link
Contributor Author

jvavrek commented May 16, 2022

https://github.com/dadadel/pyment is promising but has some rough edges including introduction of whitespace and introduction of empty docstring fields that will take some manual fixing

@jvavrek
Copy link
Contributor Author

jvavrek commented Aug 13, 2024

This would be a good task for an LLM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant