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

Support error selection via prefix codes #438

Closed
charliermarsh opened this issue Oct 15, 2022 · 3 comments
Closed

Support error selection via prefix codes #438

charliermarsh opened this issue Oct 15, 2022 · 3 comments

Comments

@charliermarsh
Copy link
Member

E.g., you should be able to --select D to enable all of the pydocstyle rules.

@matteosantama
Copy link

My concern with this is that numpy and google convention are surely the most common pydocstyle settings, and I'm not sure if --select D would make using those two any easier.

For example, to turn on convention=numpy, would you do --select D --exclude ... and list out all the codes you don't want? But then you start running into precedence issues, ie. should select or exclude take precedence?

@charliermarsh
Copy link
Member Author

Alternatively, we could support a --docstring-convention=... setting that effectively adds the right codes to --select? Also interesting could be something more general that looks more like ESLint's system of "configs" (where each "config" turns on a set of error codes).

But then you start running into precedence issues, ie. should select or exclude take precedence?

(Yeah, the point totally stands but FWIW we've already defined this such that --ignore takes precedence over --select.)

@charliermarsh
Copy link
Member Author

Oh, I'm actually going to close this as a duplicate of #325. That's my bad. We can continue discussion in there.

@charliermarsh charliermarsh closed this as not planned Won't fix, can't repro, duplicate, stale Oct 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants