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

fix: pydoclint needs a dir path #77

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lwasser
Copy link
Member

@lwasser lwasser commented Feb 27, 2025

closes #75
this just fixes a small bug and ensures we use numpy style docstrings which our packaging guide suggests.
NOTE,

@lwasser lwasser added the bug Something isn't working label Feb 27, 2025
@@ -208,7 +208,7 @@ dependencies = [
detached = true

[tool.hatch.envs.style.scripts]
docstrings = "pydoclint"
docstrings = "pydoclint src/"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the hatch lint step won't work within a dir associated with pydoclint ✨

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest to also run pydoclint on the tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove TODO in the pyproject.toml for pydoclint
2 participants