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

"$" in code examples in Readme prevents simple copy/paste #1488

Open
agirlnamedsophia opened this issue Apr 18, 2024 · 1 comment
Open

"$" in code examples in Readme prevents simple copy/paste #1488

agirlnamedsophia opened this issue Apr 18, 2024 · 1 comment

Comments

@agirlnamedsophia
Copy link

Hi! First, huge fan of sops - this is a silly "non-issue" kind of nit, but I noticed that the code examples inconsistently had the shell prompt included so when you copy / paste blocks of code into your terminal (yes yes, not good form, always verify before hitting enter) the prompt would be there for some lines. I'd like to open a PR to remove those if that's alright. Cheers!

@felixfontein
Copy link
Contributor

Thanks @agirlnamedsophia! While I agree that they aren't needed in some cases, in others they have to stay IMO, namely when commands are combined with output, like here:

$ cat ~/.aws/credentials
[default]
aws_access_key_id = AKI.....
aws_secret_access_key = mw......

Removing the $ here makes the example a lot harder to read.

This would increase inconsistence though, since then there are a lot examples that do not use $ and a lot that do use $. Right now $ is very consistently (at least I didn't find any exceptions) used when commands that are executed are marked in code blocks.

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

No branches or pull requests

2 participants