Skip to content

Commit

Permalink
Aligns doc with mpm
Browse files Browse the repository at this point in the history
  • Loading branch information
kdeldycke committed Jul 3, 2024
1 parent 5351e09 commit ed597dc
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -73,6 +73,7 @@ mdedup, version 7.3.1
Run unit-tests with:

```shell-session
$ uv install ".[test]"
$ uv run pytest
```

Expand Down Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
17 changes: 17 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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",
]

0 comments on commit ed597dc

Please sign in to comment.