From 3028f07ad7763a2e4d1d28dc7fb16c9259ac8edf Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Thu, 30 Mar 2023 19:52:29 +0300 Subject: [PATCH] Lint: Check spelling on CI but don't fail (#3080) Check spelling on CI (no fail), fix typo in docs, ignore some others --- .codespell/exclude-file.txt | 8 ++++++++ .codespell/ignore-words.txt | 2 ++ .github/workflows/lint.yml | 5 +++++ docs/rendering_system.rst | 2 +- 4 files changed, 16 insertions(+), 1 deletion(-) diff --git a/.codespell/exclude-file.txt b/.codespell/exclude-file.txt index 364eb2e28..b3b96e5b4 100644 --- a/.codespell/exclude-file.txt +++ b/.codespell/exclude-file.txt @@ -7,3 +7,11 @@ Error-de_DE=Wenn ist das Nunstück git und Slotermeyer? Ja! Beiherhund das Oder die Virtualenvironment gersput! + +`__ + + class ClassE[T: [str, int]]: ... # Type checker error: illegal expression form + class ClassE[T: t1]: ... # Type checker error: literal tuple expression required + +explicitly declared using ``in``, ``out`` and ``inout`` keywords. +| | | | | | | inout | diff --git a/.codespell/ignore-words.txt b/.codespell/ignore-words.txt index bb47e30bf..945613095 100644 --- a/.codespell/ignore-words.txt +++ b/.codespell/ignore-words.txt @@ -6,7 +6,9 @@ ba clos complies crate +dedented extraversion +falsy fo iif nd diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index cd3a584b9..943d4b6be 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -18,3 +18,8 @@ jobs: - name: Run pre-commit hooks uses: pre-commit/action@v3.0.0 + + - name: Check spelling + uses: pre-commit/action@v3.0.0 + with: + extra_args: --all-files --hook-stage manual codespell || true diff --git a/docs/rendering_system.rst b/docs/rendering_system.rst index bf793d514..9a298e0e8 100644 --- a/docs/rendering_system.rst +++ b/docs/rendering_system.rst @@ -153,7 +153,7 @@ the footer (source link and last modified timestamp). 3.5 Prepare for writing '''''''''''''''''''''''' -``pep_html_builder.FileBuilder.prepare_writing`` initialises the bare miniumum +``pep_html_builder.FileBuilder.prepare_writing`` initialises the bare minimum of the Docutils writer and the settings for writing documents. This provides a significant speed-up over the base Sphinx implementation, as most of the data automatically initialised was unused.