Fix typos and inconsistencies in help documentation #587
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
Start each description with an uppercase letter and end with a period.
danielmitterdorfer
approved these changes
Oct 19, 2018
There was a problem hiding this comment.
Thank you for your PR @msufa! It looks fine to me. I'll merge it soon and it will be targeted for the next release 1.0.2.
| default="" | ||
| ) | ||
| p.add_argument( | ||
| "--target-hosts", | ||
| help="define a comma-separated list of host:port pairs which should be targeted iff using the pipeline 'benchmark-only' " |
There was a problem hiding this comment.
fyi: "iff" is not necessarily a typo. It is short-hand for if and only if but I admit it's not widely known. However, let's keep your change here.
There was a problem hiding this comment.
I did not know that, thanks for the explanation @danielmitterdorfer
Anyway, I feel that for the vast majority of people looking at the docs the fixed spelling is going to look much less suspicious :)
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.
Start each description with an uppercase letter and end with a period.