Skip to content

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

@ssbarnea

Description

@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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions