Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
williballenthin committed Oct 19, 2023
1 parent b6a0d6e commit 84e22b1
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ We use [pre-commit](https://pre-commit.com/) so that its trivial to run the same

Run all linters liks:

❯ pre-commit run --hook-stage manual
❯ pre-commit run --hook-stage=manual --all-files
isort....................................................................Passed
black....................................................................Passed
ruff.....................................................................Passed
Expand All @@ -117,16 +117,16 @@ Run all linters liks:

Or run a single linter like:

❯ pre-commit run --hook-stage manual isort
❯ pre-commit run --all-files --hook-stage=manual isort
isort....................................................................Passed


Importantly, you can configure pre-commit to run automatically before every commit by running:

❯ pre-commit install --hook-type pre-commit
❯ pre-commit install --hook-type=pre-commit
pre-commit installed at .git/hooks/pre-commit

❯ pre-commit install --hook-type pre-push
❯ pre-commit install --hook-type=pre-push
pre-commit installed at .git/hooks/pre-push

This way you can ensure that you don't commit code style or formatting offenses.
Expand Down

0 comments on commit 84e22b1

Please sign in to comment.