From a2606cfc03b73aba54dfe22eab20df989da0b077 Mon Sep 17 00:00:00 2001 From: Steven Silvester Date: Fri, 22 Apr 2022 13:44:14 -0500 Subject: [PATCH] PYTHON-3194 Adopt doc8 checker (#931) --- .pre-commit-config.yaml | 10 ++++++++++ CONTRIBUTING.rst | 6 +++++- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 8b6671d41..1fd86e092 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -40,6 +40,7 @@ repos: 'flake8-logging-format==0.6.0', 'flake8-implicit-str-concat==0.2.0', ] + stages: [manual] # We use the Python version instead of the original version which seems to require Docker # https://github.com/koalaman/shellcheck-precommit @@ -49,6 +50,14 @@ repos: - id: shellcheck name: shellcheck args: ["--severity=warning"] + stages: [manual] + +- repo: https://github.com/PyCQA/doc8 + rev: 0.11.1 + hooks: + - id: doc8 + args: [--max-line-length=200] + stages: [manual] - repo: https://github.com/sirosen/check-jsonschema rev: 0.14.1 @@ -58,6 +67,7 @@ repos: files: ^\.github/workflows/ types: [yaml] args: ["--schemafile", "https://json.schemastore.org/github-workflow"] + stages: [manual] - repo: https://github.com/ariebovenberg/slotscheck rev: v0.14.0 diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index bbc22954a..1a4423f3e 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -55,6 +55,10 @@ To run ``pre-commit`` manually, run:: pre-commit run --all-files +To run a manual hook like `flake8` manually, run:: + + pre-commit run --all-files --hook-stage manual flake8 + Documentation ------------- @@ -67,7 +71,7 @@ You might also use the GitHub `Edit