docs: Remove dollar sign from commands #1138
Merged
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.
Summary:
The
$
isn't actually part of the command you need to execute.IMHO the docs are better without it because it makes it easier to copy/paste if you're familiar with running things from the command line, and is less confusing if you're not as you'll get an error if you include the dollar sign in the command.
Expected behavior:
Docs for commands should include exact commands that can be copy/paste into command line and execute.
Please make sure these boxes are checked before submitting your pull request - thanks!
gradle test
to make sure you didn't break anything