Remove usage of "please" in docs #494
Merged
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
With this commit we remove "please" from our docs. This makes also for more concise sentences. See https://developers.google.com/style/tone for the rationale.
danielmitterdorfer
added
enhancement
dliappis
approved these changes
May 10, 2018
docs/recipes.rst
Outdated
| @@ -32,7 +32,7 @@ First of all, we need to decide on a track. So, we run ``esrally list tracks``:: | |||
| percolator Percolator benchmark based on AOL queries 2000000 102.7 kB 104.9 MB append-no-conflicts append-no-conflicts,appe... | |||
| pmc Full text benchmark with academic papers from PMC 574199 5.5 GB 21.7 GB append-no-conflicts append-no-conflicts,appe... | |||
|
|
|||
| We're interested in a full text benchmark, so we'll choose to run ``pmc``. If you have your own data that you want to use for benchmarks, then please :doc:`create your own track</adding_tracks>` instead; the metrics you'll gather which be representative and much more useful than some default track. | |||
| We're interested in a full text benchmark, so we'll choose to run ``pmc``. If you have your own data that you want to use for benchmarks :doc:`create your own track</adding_tracks>` instead; the metrics you'll gather which be representative and much more useful than some default track. | |||
There was a problem hiding this comment.
which be representative and much more useful
will be more representative and useful
docs/race.rst
Outdated
| @@ -58,7 +58,7 @@ Rally will then start racing on this track. If you have never started Rally befo | |||
| Running index-update [ 0% done] | |||
|
|
|||
|
|
|||
| Please be patient as it will take a while to run the benchmark. | |||
| Be patient as it will take a while to run the benchmark. | |||
There was a problem hiding this comment.
This sounds a bit demanding, how about
The benchmark will take a while to run, so be patient.
There was a problem hiding this comment.
Agreed, changed.
|
Thanks for the review and suggestions @dliappis. |
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.
With this commit we remove "please" from our docs. This makes also for
more concise sentences. See https://developers.google.com/style/tone for
the rationale.