Update contributing docs to use cargo bench -p ruff_benchmark
#9535
Conversation
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
MichaReiser
approved these changes
Jan 15, 2024
dhruvmanila
pushed a commit
that referenced
this pull request
Aug 26, 2024
## Summary Noticed there was a wrong tip on the Contributing guide, `cargo benchmark lexer` wouldn't run any benches. Probably a missed update on #9535 It may make sense to remove the `cargo benchmark` command from the guide altogether, but up to the mantainers.
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
I found that
cargo benchmark lexerdidn't work as expected:❯ cargo benchmark lexer Finished bench [optimized] target(s) in 0.08s Running benches/formatter.rs (target/release/deps/formatter-4e1d9bf9d3ba529d) Running benches/linter.rs (target/release/deps/linter-e449086ddfd8ad8c)Turns out that
cargo bench -p ruff_benchmarkis now recommended overcargo benchmark, so updating the docs to reflect that.