👌 Add pre-commit-hook to run pydoclint via flake8

[s-weigand]

Since I want the inline ignore feature when running pydoclint via flake8 I'm using a hook like so.

  - repo: https://github.com/PyCQA/flake8
    rev: 7.1.1
    hooks:
      - id: flake8
        alias: flake8-docs
        args:
          - "--select=DOC"
          - "--extend-ignore=DOC502,DOC601,DOC603"
          - "--color=always"
          - "--require-return-section-when-returning-nothing=False"
          - "--allow-init-docstring=True"
          - "--skip-checking-short-docstrings=False"
        name: "lint docstrings"
        exclude: "^(docs/|tests?/)"
        additional_dependencies: [pydoclint==0.5.6]

This has the obvious drawback that I manually need to look up the latest version of pydoclint and update it (If I don't forget the additional dependency, see how outdated it is 😥).

Having a flake8 based hook in the pydoclint repo would allow me to easily keep up with the latest and greatest version.

  - repo: https://github.com/jsh9/pydoclint
    rev: <autoupdatable version>
    hooks:
      - id: pydoclint-flake8
        alias: flake8-docs
        args:
          - "--select=DOC"
          - "--extend-ignore=DOC502,DOC601,DOC603"
          - "--color=always"
          - "--require-return-section-when-returning-nothing=False"
          - "--allow-init-docstring=True"
          - "--skip-checking-short-docstrings=False"
        name: "lint docstrings"
        exclude: "^(docs/|tests?/)"

[s-weigand]

While writing the PR body it came to my mind that I could also just overwrite the entry of the existing hook to get the same effect.

  - repo: https://github.com/jsh9/pydoclint
    rev: ""
    hooks:
      - id: pydoclint
        alias: lint-docs
        entry: flake8
        args:
          - "--select=DOC"
          - "--extend-ignore=DOC502,DOC601,DOC603"
          - "--color=always"
          - "--require-return-section-when-returning-nothing=False"
          - "--allow-init-docstring=True"
          - "--skip-checking-short-docstrings=False"
        name: "lint docstrings"
        exclude: "^(docs/|tests?/)"
        additional_dependencies: [flake8]

However I think that running pydoclint via flake8 is such a common need that it would justify its own hook.

[jsh9]

This is a very good idea. Thanks!

Let me add version bump and other stuff to this PR.