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

Remove $ prefix because it was copied when copying the command #150

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

aakarshan-raj
Copy link

No description provided.

@gitname
Copy link
Owner

gitname commented Jul 8, 2023

Hi @aakarshan-raj, thanks for proposing these changes.

At first glance at the changes, I was on board with making them, except that I was going to request that you (a) delete the two spaces that used to be occupied by the $ that you removed; and (b) restore the $ before the commands that appear within paragraphs, since that makes it easier for me to identify shell commands within paragraphs.

However, as I was drafting a reply containing those requests, I remembered that some of the code snippets in this repository also contain example output (which I do not want readers to copy/paste into their shells). So, I'm not ready to strip out the $ prefixes just yet, because I don't know how I would then distinguish the example output from the command, itself (currently, I use the $ prefix to distinguish them).

I'll think about how I could facilitate copy/pasting, while also distinguishing the commands from the example output.

@gitname
Copy link
Owner

gitname commented Jul 8, 2023

I may just include a note saying that the $ prefix represents the shell prompt, and I don't intend for readers to include that in the commands they issue.

@gitname gitname changed the title removed $ from readme.md as it was copied when copying the command Remove $ prefix because it was copied when copying the command Jul 8, 2023
@gitname gitname self-assigned this Jul 8, 2023
@Yuskhosmith Yuskhosmith mentioned this pull request Oct 5, 2023
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants