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 numpydoc-validation to pre-commit checks #39

Closed
ns-rse opened this issue Apr 30, 2024 · 0 comments · Fixed by #40
Closed

Add numpydoc-validation to pre-commit checks #39

ns-rse opened this issue Apr 30, 2024 · 0 comments · Fixed by #40
Assignees
@ns-rse
Labels
ci Continuous Integration

Comments

@ns-rse
Copy link
Collaborator

ns-rse commented Apr 30, 2024

We use docstrings in this package and to be consistent and align with linting of TopoStats we should add numpydoc-validation to the suite of pre-commit hooks we have in place.

The following will add this.

  - repo: https://github.com/numpy/numpydoc
    rev: v1.6.0
    hooks:
      - id: numpydoc-validation
@ns-rse ns-rse added the ci Continuous Integration label Apr 30, 2024
@ns-rse ns-rse self-assigned this Apr 30, 2024
ns-rse added a commit that referenced this issue Apr 30, 2024
@ns-rse
ci: Adds numpydoc-validation to pre-commit hooks
5a82a72 
Closes #39
@ns-rse ns-rse mentioned this issue Apr 30, 2024
Merged
@ns-rse ns-rse closed this as completed in #40 May 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ns-rse ns-rse

Labels
ci Continuous Integration
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

ci: Adds numpydoc-validation to pre-commit hooks AFM-SPM/AFMReader
1 participant
@ns-rse