From 91a648fa3e6e5fccb5d2b2b4bade74c9457feee8 Mon Sep 17 00:00:00 2001 From: MDW Date: Wed, 17 Jan 2024 11:06:12 +0100 Subject: [PATCH] doc: codespell - Add some more instructions # Qual: Add some more instructions to the 'codespell' ignore script. As codespell will likely be run from pre-commit where codespell is installed in a venv for the user, running addCodespellIgnores.sh from the CLI requires installation of codespell for the developer's environment. This add some information inside the script about that. --- dev/tools/codespell/addCodespellIgnores.sh | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/dev/tools/codespell/addCodespellIgnores.sh b/dev/tools/codespell/addCodespellIgnores.sh index 476c5ba287e..0b73c4c16b2 100755 --- a/dev/tools/codespell/addCodespellIgnores.sh +++ b/dev/tools/codespell/addCodespellIgnores.sh @@ -11,10 +11,22 @@ # ```shell # echo > dev/tools/codespell/codespell-lines-ignore.txt # ``` -# and then execute this script +# and then execute this script. # # author: https://github.com/mdeweerd +# +# :warning: +# +# This script only works properly if codespell is install for your CLI. +# As the configuration is in pyproject.toml, you also need tomli. +# +# ```shell +# python -m pip install codespell tomli +# # or +# pip install codespell tomli +# ``` + codespell_ignore_file=dev/tools/codespell/codespell-lines-ignore.txt if [ -z "${0##*.sh}" ] ; then # Suppose running from inside script