-
Notifications
You must be signed in to change notification settings - Fork 226
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
Bash prompts and single-word heading capitalization #106
Conversation
LGTM |
@@ -5,6 +5,7 @@ This is the documentation styleguide for our natural language descriptions used | |||
## Code references | |||
|
|||
* Use `backticks` for every code example inside of a normal description. In the CLI, where you cannot use backticks, use 'single quotes' for commands. | |||
* For bash arguments, do not include a `$` before commands in man pages. A `$` may be included in READMEs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does "bash arguments" mean here? Perhaps "command line invocations"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe not bash
but rather shell
as there are more shells than just bash ;)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shell
makes sense. Does that satisfy you, @noffle?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm partial to command line
, if only because I get the [subjective] impression more people know what it means than shell
. Either works for me. 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
('shell' includes graphical as well as voice input, e.g. https://www.emacswiki.org/emacs/EmacSpeak)
b05c7a8
to
9b80855
Compare
Citation suggestion: much like how https://github.com/ipfs/community/blob/master/code-of-conduct.md attributes the npm code of conduct, I think this should be the case as well for ('@'related: if you want to see what precedes npm coc, and so on, here is an incomplete visualization of it http://ideapad.io/code-of-conduct-phylogenetic-tree/graph) |
LGTM |
@rht That makes sense to me. We can link that. Want to make a PR about it? |
Ping @whyrusleeping @rht @jbenet for review |
9b80855
to
ed7bb1b
Compare
@jbenet is going to want |
@whyrusleeping agreed. I'm not sure when to use that: everywhere? I see two issues with this. One is that most beginners come from Mac environments, I would think, and would be used to
Where |
yeah, i'm personally not a fan of using |
I just checked
|
9747792
to
0b13a92
Compare
Waiting for LGTM from: