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

Standardize Python Docstrings #30

Open
jamesETsmith opened this issue Sep 20, 2024 · 0 comments
Open

Standardize Python Docstrings #30

jamesETsmith opened this issue Sep 20, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jamesETsmith
Copy link
Contributor

General

We should standardize all Python docstrings to use a style (NumPy) and have CI/precommit checks that enforce that standard. Right now, ruff doesn't look like it's actually enforcing that check.

Details

When working in vscode we should make sure we're using the docstring extension (make sure that you set the desired style to NumPy).
@jamesETsmith jamesETsmith added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 20, 2024
@jamesETsmith jamesETsmith mentioned this issue Sep 20, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jamesETsmith