Repository navigation
chore: benchmarks compare.py documentation fixes - #24505
Merged
Merged
Conversation
adamreeve
commented
Aug 20, 2026
| type=float, | ||
| default=0.05, | ||
| help="The threshold for statistically insignificant results (+/- %5).", | ||
| help="The threshold for statistically insignificant results (+/- 5%%).", |
Contributor
Author
There was a problem hiding this comment.
The help text supports %-formatting so the % needs to be escaped.
Without this, running with --help gives:
ValueError: unsupported format character ')' (0x29) at index 6
Also, the % should come after the 5.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #24505 +/- ##
==========================================
- Coverage 81.27% 81.27% -0.01%
==========================================
Files 1114 1115 +1
Lines 393606 394817 +1211
Branches 393606 394817 +1211
==========================================
+ Hits 319920 320877 +957
- Misses 54946 55144 +198
- Partials 18740 18796 +56 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Contributor
Author
|
Hi @adriangb, could you please review this? |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
Which issue does this PR close?
No issue, this is a minor change and not user-facing.
Rationale for this change
Help developers run benchmarks without getting distracted by errors and trying commands that no longer work.
What changes are included in this PR?
Updates documentation for
compare.pyto account for the switch to uv (#20414) and fixes a crash when getting the help output (running with--help).Are these changes tested?
Yes, I've run the script.
Are there any user-facing changes?
No.