-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update contributing docs to use cargo bench -p ruff_benchmark
- Loading branch information
1 parent
0c0d3db
commit 56a1dae
Showing
2 changed files
with
20 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,16 @@ | ||
# Ruff Benchmarks | ||
|
||
The `ruff_benchmark` crate benchmarks the linter and the formatter on individual files. | ||
The `ruff_benchmark` crate benchmarks the linter and the formatter on individual files: | ||
|
||
```shell | ||
# Run once on the "baseline". | ||
cargo bench -p ruff_benchmark -- --save-baseline=main | ||
|
||
# Compare against the "baseline". | ||
cargo bench -p ruff_benchmark -- --baseline=main | ||
|
||
# Run the lexer benchmarks. | ||
cargo bench -p ruff_benchmark lexer -- --baseline=main | ||
``` | ||
|
||
See [CONTRIBUTING.md](../../CONTRIBUTING.md) on how to use these benchmarks. |