diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml index 4d5cccb..36c9884 100644 --- a/.pre-commit-hooks.yaml +++ b/.pre-commit-hooks.yaml @@ -282,7 +282,7 @@ name: Check max one sentence per line description: |- This hook is a simplified version of [rumdl MD013 sentence-per-line-mode](https://github.com/rvben/rumdl/blob/main/docs/md013.md#sentence-per-line-mode). - We recommend rumdl over this hook if possible. + In contrast to rumdl, this hook doesn't reflow all your text; it only enforces one sentence per line. Check that each line in markdown files contains at most one sentence. This makes diffs easier to read and avoids merge conflicts. diff --git a/README.md b/README.md index 6fdca2a..9bc467b 100644 --- a/README.md +++ b/README.md @@ -221,7 +221,7 @@ sync_versions: ### `check-max-one-sentence-per-line` This hook is a simplified version of [rumdl MD013 sentence-per-line-mode](https://github.com/rvben/rumdl/blob/main/docs/md013.md#sentence-per-line-mode). -We recommend rumdl over this hook if possible. +In contrast to rumdl, this hook doesn't reflow all your text; it only enforces one sentence per line. Check that each line in markdown files contains at most one sentence. This makes diffs easier to read and avoids merge conflicts.