Fix styling of arguments#4022
Conversation
ashlymat
force-pushed
the
docStyleFix
branch
from
951d782 to
754d318
Compare
Signed-off-by: Ashly Mathew <ashlymathew93@gmail.com>
ashlymat
force-pushed
the
docStyleFix
branch
from
754d318 to
de9b47a
Compare
|
@kolyshkin Could you do a review? |
|
Looks like CI got stuck (probably because some changes were made); let me try a close/reopen to trigger it |
| driver and "system.slice" for systemd cgroup driver. | ||
|
|
||
| **--config-file**="/etc/docker/daemon.json" | ||
| **--config-file**=*"/etc/docker/daemon.json"* |
There was a problem hiding this comment.
- This is wrong to put a default value (like done here) or an example value in synopsis. The proper way would be to say something like
**--config-file**=*"path"*and add
Default is */etc/docker/daemon.json*.to the option description.
There was a problem hiding this comment.
To explain the last part -- while a file name (such as /etc/docker/daemon.json) is a literal, the man page convention is to typeset it as italic.
| Enable debug mode. Default is false. | ||
|
|
||
| **--default-cgroupns-mode**="**host**|**private**" | ||
| **--default-cgroupns-mode**="*host*|*private*" |
There was a problem hiding this comment.
Here, both host and private are literals, i.e. they should be used as-is. Therefore, those are typeset in bold and should not be changed.
OTOH, if that would be something like default-cgroup-mode=MODE, the MODE should be in italic, as it's a value to be substituted.
|
Opened #4215 to fix the issues from this PR (described above). |
3 participants
Signed-off-by: Ashly Mathew ashlymathew93@gmail.com
- What I did
Small contribution to #923 - changing arguments of options to italics
- How I did it
- How to verify it
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)