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

Make copying and pasting terminal commands easier #5416

Merged
merged 2 commits into from
Jun 9, 2023

Conversation

DerekCrosson
Copy link
Contributor

@DerekCrosson DerekCrosson commented Nov 1, 2021

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • QA Issue Fix
  • Optimization
  • Documentation Update

Description

Removes the dollar sign from the beginning of terminal commands.

Problem

When the commands that have the terminal beginning of line symbol in front of them are copied to the clipboard using the copy button in the code block, the user has to first remove the symbol to run the command. Running the command without first removing this symbol will result in an error.

Solution

Remove the terminal beginning of line symbol so that the user can click the button in the code block to copy to clipboard and then simply past the command in the terminal and press the return key to run it.

Related Issues, Tickets & Documents

N/A

UI accessibility concerns?

N/A

Added/updated tests?

  • Yes
  • No, and this is why: documentation update, tests not necessary.
  • I need help with writing tests

[optional] Are there any post deployment tasks we need to perform?

No.

When you copy the commands that have the terminal beginning of line symbol in front of them you now no longer need to first delete this before running the command
…nds-copied-to-clipboard

chore: remove dollar symbol from some commands
@p8
Copy link
Contributor

p8 commented May 31, 2022

With github's copy button this does seem like a nice change.
It seems most Ruby projects still have the prompt.
The only example I could find of removing it for easy copying, is the Rust README: rust-lang/rust#76863

@mcmuralishclint
Copy link

Good one

@rafaelfranca rafaelfranca merged commit ec06745 into heartcombo:main Jun 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants