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
docker, ollama, history, tldr: fix mnemonics #12762
base: main
Are you sure you want to change the base?
Conversation
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.
Thanks for your contribution, I have some suggestions for this page.
While we support contextual mnemonics in the style guide, it is mostly useful when there are multiple options to highlight or in translations. But IMO, adding mnemonics to descriptions in the history.md
file isn't required since the description already implies it, so can you revert the changes to it?
Other suggestions can be found in my review comments.
@@ -12,7 +12,7 @@ | |||
|
|||
`tldr {{command}} {{subcommand}}` | |||
|
|||
- Print the tldr page for a command in the given [L]anguage (if available, otherwise fall back to English): | |||
- Print the tldr page for a command in the given [l]anguage (if available, otherwise fall back to English): |
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.
- Print the tldr page for a command in the given [l]anguage (if available, otherwise fall back to English): | |
- Print the tldr page for a command in the given [L]anguage (if available, otherwise fall back to English): |
The mnemonic capitalization is right here as it is used to highlight the short option for specifying a language in clients. The other change below for the list option looks fine.
Thanks for your helpful comments @kbdharun . It is not a problem at all to revert changes in |
I'm OK if the mnemonic change in
|
@vitorhcl Thanks for your comments, I agree with you, particularly with regard to 4. I think it's generally a better practice to maintain consistency in the rule, and keeping an objective rule helps in that respect, rather than relying on somewhat subjective matters such as implication, although I understand it's understandable sometimes. @kbdharun @vitorhcl Your input is much appreciated as always ;) |
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
common
,linux
,osx
,windows
,sunos
,android
, etc.