Clarify docs on repo analysis params #5221
Closed
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
Makes it explicit that for realistic experiments you need to leave many of the parameters alone: for instance setting `?concurrency=1` is not a realistic experiment. Also adjusts the wording slightly to use the imperative voice more.
szabosteve
approved these changes
Sep 1, 2025
Contributor
szabosteve
left a comment
szabosteve
left a comment
There was a problem hiding this comment.
Thank you for this improvement! LGTM!
Contributor
|
@DaveCTurner The CI fails because you opened the PR from a fork. @pquentin What's the recommendation in cases like this? |
Contributor
Author
|
I can reopen this with a branch from the main repo if you'd prefer, tho it is common in all other repositories to work on forks. |
Contributor
Author
|
I moved the branch to the main repo and opened #5247 instead, closing this |
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.
Makes it explicit that for realistic experiments you need to leave many
of the parameters alone: for instance setting
?concurrency=1is not arealistic experiment.
Also adjusts the wording slightly to use the imperative voice more.