Update commands.md#2966
Conversation
removed question marks since they're not meant to be typed and their meaning is equivocal
|
I think these question marks are meant to convey that the parameters are optional. |
|
Right, but other optional parameters lack them. In any case, why not just use standard man notation, i.e., brackets |
Which ones? Might be good to fix them.
Yeah, I think that's a good idea. The So I'd vote for replacing it with the brackets notation, rather than removing it completely. |
|
They are meant to denote optional parameters (regex notation). Switching to brackets sounds good to me, and fixing any other optional parameters that are not marked properly would also be good. |
added brackets around optional arguments, and added 'key' placeholder indicating a required argument for 'showkey'
|
Done. What about parameters like |
|
Yep, it's an important thing to clarify. Actually there is already the |
|
Okay. When I see single quotes in the programming/command line/IT world, I read it as a form of shell escaping, which isn't the same thing as replacing an argument with appropriate text. But yeah, probably no reason to use both italics and single quotes. I'll make the change. |
added single quotes inside of bracketed optional params (though I feel they should be reserved for shell escaping, and italics should be used for replacing text of arguments. I also added brackets (and quotes) around the `exec` parameter for `term`, although I'm not really sure if that's right because this command doesn't work on my system.
Yep, using single quotes in this context doesn't look conventional to me either. But it has the advantage of not depending on the highlighting or on the terminal capabilities (italics don't always work hassle-free in a terminal, actually it seems they more often don't then do), so I don't see a better option right now. |
removed question marks since they're not meant to be typed and their meaning is equivocal (other options interpretable as interrogative lack them)