Skip to content

Commit

Permalink
Update whitespace
Browse files Browse the repository at this point in the history
  • Loading branch information
adamtheturtle committed Nov 7, 2024
1 parent 6fbb6a6 commit 9fe81c8
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ repos:
- id: file-contents-sorter
files: spelling_private_dict\.txt$
- id: trailing-whitespace
exclude: ^tests/test_doccmd/.*\.txt$
- repo: https://github.com/pre-commit/pygrep-hooks
rev: v1.10.0
hooks:
Expand Down
6 changes: 3 additions & 3 deletions tests/test_doccmd/test_help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,21 @@ Options:
configurations. [default: doccmd; required]
--skip-marker TEXT The marker used to identify code blocks to be
skipped.

By default, code blocks which come just after
a comment matching 'skip doccmd[all]: next'
are skipped (e.g. `.. skip doccmd[all]: next`
in reStructuredText, `<!--- skip doccmd[all]:
next -->` in Markdown, or `% skip doccmd[all]:
next` in MyST).

When using this option, those, and code blocks
which come just after a comment including the
given marker are ignored. For example, if the
given marker is 'type-check', code blocks
which come just after a comment matching 'skip
doccmd[type-check]: next' are also skipped.

This marker is matched using a regular
expression.
--pad-file / --no-pad-file Run the command against a temporary file
Expand Down

0 comments on commit 9fe81c8

Please sign in to comment.