DOC: contributing: fix asv usage instructions #13794
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
By default asv continuous uses head^ as the commit to compare to, whereas for PRs you usually want to compare to master.
Current coverage is 85.33% (diff: 100%)@@ master #13794 diff @@
==========================================
Files 141 141
Lines 50711 50711
Methods 0 0
Messages 0 0
Branches 0 0
==========================================
Hits 43275 43275
Misses 7436 7436
Partials 0 0
|
|
|
||
| This command uses ``conda`` by default for creating the benchmark | ||
| You can replace ``HEAD`` with the name of the branch you are working on. |
There was a problem hiding this comment.
'You can' -> but it is not needed?
|
@pv Thanks a lot for clarifying this! |
|
Yes, you can replace HEAD with a branch name, but is not necessary.
|
|
@pv I have actually another questions (was using the asv benchmark suite the last days): is there a way to run the suite for a specific commit? As with |
|
asv run commit^! (git single-commit range spec)
|
|
@pv Aha, thanks! |
3 tasks
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 current asv usage instructions in contributing.rst may be unclear for PRs with multiple commits.
By default
asv continuoususes head^ as the commit to compare to, whereas for PRs you usually want to compare to master. Write the instructions so that the comparison point is clear.