mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-12-04 01:36:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Update pre-commit documentation (#8545)

Browse source 
I got some feedback on Mastodon that it wasn't clear how to use the
linter and formatter together in pre-commit (mostly in the pre-commit
repo's documentation, which is even less clear, but the two should be
consistent).
This commit is contained in:
Charlie Marsh 2023-11-07 10:40:13 -08:00 • committed by GitHub
parent 03303a9edd
commit ce549e75bc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 27 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/tutorial.md
View file

@ -341,17 +341,13 @@ This tutorial has focused on Ruff's command-line interface, but Ruff can also be
[pre-commit](https://pre-commit.com) hook via [`ruff-pre-commit`](https://github.com/astral-sh/ruff-pre-commit):
```yaml
# Run the Ruff linter.
- repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version.
rev: v0.1.4
hooks:
# Run the linter.
- id: ruff
# Run the Ruff formatter.
- repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version.
rev: v0.1.4
hooks:
# Run the formatter.
- id: ruff-format
```