diff --git a/docs/development.md b/docs/development.md index 62e557de..4d0712aa 100644 --- a/docs/development.md +++ b/docs/development.md @@ -11,7 +11,7 @@ This project more or less follows [Semantic Versioning](https://semver.org/). -Which boils down to the following rules of thumb regarding stability: +Which boils down to the following these rules of thumb regarding stability: - **Patch releases**: `0.x.n` → `0.x.(n+1)` upgrades @@ -56,7 +56,7 @@ $ source .venv/bin/activate $ uv pip install --all-extras . ``` -Now you’re ready to hack and abuse git! +Now you’re ready to hack and abuse `git`. ## Test `mdedup` development version @@ -73,6 +73,7 @@ mdedup, version 7.3.1 Run unit-tests with: ```shell-session +$ uv install ".[test]" $ uv run pytest ``` @@ -102,6 +103,7 @@ To produce clean and fancy terminals screenshots, use either: - [Graphite Shot](https://graphite-shot.now.sh) - [Carbon](https://github.com/carbon-app/carbon) - [CodeKeep](https://codekeep.io/screenshot) +- [chalk.ist](https://chalk.ist) ## Changelog diff --git a/docs/install.md b/docs/install.md index 850e89fd..51daaf3a 100644 --- a/docs/install.md +++ b/docs/install.md @@ -11,7 +11,9 @@ Easiest way is to [install `pipx`](https://pipx.pypa.io/stable/installation/), t $ pipx install mail-deduplicate ``` +```{note} `pipx` is to `pip` what `npx` is to `npm`: a clean way to install and run Python applications in isolated environments. +``` ```` ````{tab-item} pip diff --git a/pyproject.toml b/pyproject.toml index 6667324b..d60666f0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -155,3 +155,20 @@ filename = "./citation.cff" regex = true search = "date-released: \\d{{4}}-\\d{{2}}-\\d{{2}}" replace = "date-released: {utcnow:%Y-%m-%d}" + +[tool.typos] +default.extend-ignore-identifiers-re = [ + # error: `ist` should be `is`, `it`, `its`, `sit`, `list` + # --> ./docs/development.md:121:10 + # | + # 121 | - [chalk.ist](https://chalk.ist) + # | ^^^ + # | + # error: `ist` should be `is`, `it`, `its`, `sit`, `list` + # --> ./docs/development.md:121:29 + # | + # 121 | - [chalk.ist](https://chalk.ist) + # | ^^^ + # | + "ist", +]