Pydoclint pre-commit hook configuration is not fully compatible with pre-commit.ci

[ssbarnea]

Because pydoclint defaults is to print each linted file (as opposed to most of other linters I know), what can happen on codebases with lots of files is to get a failure that you cannot read, like https://results.pre-commit.ci/run/github/320052445/1744716357.aRJoLaVxTEebqlvfkRO9LQ

I will include a screenshot as the link to pre-commit.ci failure will disappear after some time:

Basically the error is hidden as being inside the automatically truncated output (which might make sense as it is likely a security measure).

The fix for this is to add -q to the default list of argument inside the hook definition.

I would personally make pylintdoc itself be silent by default but I suppose that @jsh9 might not want it.

A workaround for those that encounter this bug is to configure it in pyproject.toml

[tool.pydoclint]
quiet = true # needed as it can break pre-commit

[jsh9]

Hi, thanks for opening this issue!

I can change --quiet to default to True. I don't remember having strong opinions when I set up this config option. It's a backward incompatible change, but its impact is quite minor, so I think it's fine.

That said, the truncation behavior of pre-commit.ci is a bit concerning. In my opinion, a CI platform should not truncate any logs. If long logs make rendering in browsers difficult, the platform should create a link to the full log.

With their current behavior, even if --quiet is True in pydoclint, useful logs may still be truncated if your repo has a lot of files with a lot of violation messages.

While I make code changes on my end, I'd suggest that your team also raise an issue over there.

[jsh9]

This is fixed in 0.6.6.