Skip to content

signing.asc: Standardize on using "$" to represent command markup#1078

Merged
ben merged 1 commit intomasterfrom
unknown repository
Jun 11, 2018
Merged

signing.asc: Standardize on using "$" to represent command markup#1078
ben merged 1 commit intomasterfrom
unknown repository

Conversation

@ghost
Copy link
Copy Markdown

@ghost ghost commented Jun 9, 2018

I propose that all command markup (even single-line markup)
use a dollar sign to signify a command, just for consistency.
Otherwise, it looks kind of weird as it bounces back and forth
between the two.

Signed-off-by: Robert P. J. Day rpjday@crashcourse.ca

I propose that *all* command markup (even single-line markup)
use a dollar sign to signify a command, just for consistency.
Otherwise, it looks kind of weird as it bounces back and forth
between the two.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
@ben
Copy link
Copy Markdown
Member

ben commented Jun 11, 2018

I'm with you for block-level examples, but inline it doesn't make a ton of sense. Compare these:

Simply run the foo bar baz command, and you'll see that…

Simply run the $ foo bar baz command, and you'll see that…

The monospace segment is meant to be a noun. Adding the shell prompt encumbers it with all the shell/console/bash-vs-zsh-vs-fish context, none of which is what we're trying to talk about.

@ben ben merged commit bee8a35 into progit:master Jun 11, 2018
@ghost ghost deleted the signing branch June 11, 2018 17:25
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.

2 participants