Improve benchmark docs #14820
Improve benchmark docs #14820
Conversation
The command as written gives you `cargo` help, not `tpch` help as the text above says. And the output shown was for the benchmark bin, not the subcommand. Also correct some inconsistencies and punctuation.
alamb
left a comment
alamb
left a comment
There was a problem hiding this comment.
Thank you @carols10cents -- this looks good to me
I don't have any new benchmark to write to try these instructions out but they look good to me. Maybe @2010YOUY01 who recently added a benchmark could take a look at this one as well?
| section on adding a benchmark subcommand and add code to create or download data as part of its | ||
| `run` function. | ||
|
|
||
| If you want to create or download the data with shell commands, in `benchmarks/bench.sh`, define a |
There was a problem hiding this comment.
thank you -- this content is great @carols10cents
I worry it will get out of sync being in a different file.
However, since it involves editing multiple files, I can't think of any place better to put it 🤔
github-actions
bot
removed
the
documentation
|
I also just added a commit removing the sentence about commenting on a PR with |
I think it was done in |
|
Thanks again @carols10cents |
* Correct docs on subcommand help The command as written gives you `cargo` help, not `tpch` help as the text above says. And the output shown was for the benchmark bin, not the subcommand. Also correct some inconsistencies and punctuation. * Docs on how to add a new benchmark * Improve wording and punctuation in benchmarks README * Remove help text about /benchmark PR command that's disabled
2 participants
Which issue does this PR close?
Rationale for this change
I added a new benchmark in #14818. There wasn't documentation on how to add a new benchmark (and some of the existing docs were wrong) so I wrote up what I did as I figured it out. I guessed a lot, so please correct me!
What changes are included in this PR?
New and improved docs!
Are these changes tested?
No, but I'd love to have someone try following the new docs to test if they're clear and helpful!
Are there any user-facing changes?
Nope!