DOC: update benchmarking docs to use dev.py user interface #16633
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
The runtest.py module is being phased out in favor of the dev.py module.
j-bowhay
added
Documentation
The runtest.py module is being phased out in favor of the dev.py module. [skip azp] [skip actions]
…to my-dev-branch
|
I think the other commands will need revising too--I just did a few spot checks to get you started down the right path. |
tupui
added
the
sprint
|
@hfactor13 this change would be good to get merged. Are you planning to update this PR? |
rgommers
changed the title
|
Yes, I just have to run the tests and I think I should be good. |
Replaced "--bench" with "bench" for running all benchmarks, and "bench -t" for running specific benchmarks.
|
I just pushed my commits. Let me know if there's anything else I am missing. |
Also update the doc command for it [skip ci]
rgommers
approved these changes
Sep 4, 2022
There was a problem hiding this comment.
Thanks @hfactor13. There was one more issue with the bench --compare command, I fixed the docs and the actual implementation so it runs correctly now. In it goes.
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.
The runtest.py module is being phased out in favor of the dev.py module.
Reference issue
What does this implement/fix?
This fixes the documentation to include the new test module.
Additional information