Skip to content

Conversation

jsh9
Copy link
Owner

@jsh9 jsh9 commented May 18, 2025

Fixes #237.

Reverts the changes in #236 (which was to address #233).

@jsh9
Copy link
Owner Author

jsh9 commented May 18, 2025

Hi @ssbarnea, I had to revert the default of --quiet to False because of a practical constraint.

Here are the details:

--quiet was set up to be a "flag" (is_flag=True). So if it's default to False, you can add --quiet into your command to silence pydoclint, and if you don't add --quiet, pydoclint will print each file it processes. But if it's default to True, there's no way to make pydoclint print each file it processes.

This is a design oversight (I shouldn't have made it a "flag"), but now it's too late to change it without breaking things for a lot of users.

Worse yet, if I turn --quiet into not a flag, the error message would not be informative nor actionable:

Usage: pydoclint [OPTIONS] [PATHS]...
Try 'pydoclint -h' for help.

Error: Invalid value for '-q' / '--quiet': '.' is not a valid boolean.

(I can't improve this error message, because it comes from the click package that controls all config options.)

So after some debate, I think the most practical option is to revert to the old behavior. Fortunately, you can use your old workaround, which sets the --quiet flag.

@jsh9 jsh9 merged commit 37fa474 into main May 18, 2025
16 checks passed
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

Successfully merging this pull request may close these issues.

"--quiet" is not working as expected in 0.6.6
1 participant