Improve benchmark documentation #15054
Merged
Conversation
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
alamb
approved these changes
Mar 6, 2025
Contributor
alamb
left a comment
alamb
left a comment
There was a problem hiding this comment.
Thank you as always @carols10cents 🙏
| The output of `dfbench` help includes a description of each benchmark, which is reproduced here for convenience | ||
| The output of `dfbench` help includes a description of each benchmark, which is reproduced here for convenience. | ||
|
|
||
| ## Cancellation |
|
|
||
| let mut rundata = BenchmarkRun::new(); | ||
| rundata.start_new_case("Arglebargle"); | ||
| rundata.start_new_case("Cancellation"); |
Contributor
There was a problem hiding this comment.
🤦 -- sorry about that.
Though today I have learned a new placeholder word!
carols10cents
changed the title
Contributor
|
Thanks again @carols10cents |
danila-b
pushed a commit
to danila-b/datafusion
that referenced
this pull request
Mar 8, 2025
* Replace placeholder with a more appropriate benchmark title * Clarify purpose of this benchmark * Add cancellation benchmark to benchmarks README
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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?
This is a follow-on to #14818.
Rationale for this change
There were some further improvements to the documentation that @alamb and I noticed after #14818 was merged in.
What changes are included in this PR?
I noticed there was a label with the text "Arglebargle" that I put in there before I knew where that text ended up (it's a heading in the
bench.shoutput)@alamb had a suggestion in the previous PR that I've now taken
In my next PR, @alamb noticed I forgot to add this benchmark's description to
benchmarks/README.mdAre these changes tested?
Nope, they're just docs :)
Are there any user-facing changes?
These are the docs :)