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

Remove TODO in the pyproject.toml for pydoclint #75

Open
lwasser opened this issue Feb 27, 2025 · 1 comment · May be fixed by #77
Open

Remove TODO in the pyproject.toml for pydoclint #75

lwasser opened this issue Feb 27, 2025 · 1 comment · May be fixed by #77

Comments

@lwasser
Copy link
Member

lwasser commented Feb 27, 2025

If you look at the pyproject toml file created for "bells and whistles" option, there are some TODO's that we should to address

Let's go wtih numpy as a standard for the scientific ecosystem given we suggest that in our guide and remove the TODO. :)

[tool.pydoclint]
style = "google"  # TODO: Other styles are possible here, like 'numpy'
@lwasser
Copy link
Member Author

lwasser commented Feb 27, 2025

related to this - when i run hatch run style:check

I get the following:

➜ hatch run style:check     
DEPRECATION: --no-python-version-warning is deprecated. pip 25.1 will enforce this behaviour change. A possible replacement is to remove the flag as it's a no-op. Discussion can be found at https://github.com/pypa/pip/issues/13154
cmd [1] | pydoclint
You did not specify a path to run pydoclint on

I haven't used pydoclint before. I am going down this rabbit hole because #73 is failing CI so i'm trying to hunt down what is going on :) but mostly i'm going in circles 😆

@lwasser lwasser linked a pull request Feb 27, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: pydoclint needs a dir path lwasser/pyos-package-template
1 participant
@lwasser