Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Remove dollar sign from commands #1138

Merged
merged 1 commit into from
May 10, 2022

Conversation

barbeau
Copy link
Member

@barbeau barbeau commented May 10, 2022

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!

  • Run the unit tests with gradle test to make sure you didn't break anything
  • Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • Linked all relevant issues
  • Include screenshot(s) showing how this pull request works and fixes the issue(s)

It's not 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.
@barbeau barbeau added the documentation Anything related to our documentation label May 10, 2022
Copy link
Contributor

@maximearmstrong maximearmstrong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thank you @barbeau

@maximearmstrong maximearmstrong merged commit 11340f9 into master May 10, 2022
@maximearmstrong maximearmstrong deleted the sean/remove-dollar-sign branch May 10, 2022 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to our documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants