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

Add docstring style enforcement #11

Open
ginic opened this issue Jan 3, 2024 · 0 comments
Open

Add docstring style enforcement #11

ginic opened this issue Jan 3, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@ginic
Copy link
Contributor

ginic commented Jan 3, 2024

Docstrings: While the project uses Sphinx for documentation, it could be beneficial to enforce a consistent docstring style (like Google or NumPy) using a tool like pydocstyle.

Definition of done:

  • Add docstring style enforcement to developer dependencies
  • Update documentation section of README to describe what docstring style enforcement is and how to run it
@ginic ginic added the enhancement New feature or request label Jan 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ginic