Skip to content
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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

swoh816
Copy link
Contributor

@swoh816 swoh816 commented May 8, 2024

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

@github-actions github-actions bot added the page edit Changes to an existing page(s). label May 8, 2024
Copy link
Member

@kbdharun kbdharun left a 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):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 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.

pages/common/ollama.md Outdated Show resolved Hide resolved
pages/common/ollama.md Show resolved Hide resolved
@swoh816
Copy link
Contributor Author

swoh816 commented May 9, 2024

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.

Thanks for your helpful comments @kbdharun . It is not a problem at all to revert changes in history.md file. Just one clarification question: What do you mean by that mnemonics are useful when there are multiple options to highlight or in translation? Also, isn't it generally helpful to indicate mnemonics in the description, whether or not the description implies the mnemonics? In fact, most of the mnemonics can be inferred by the associated options anyway, such as -r of rm -r for recursive, -f for rm -f for forcefully. But I still thought you should indicate them in the description even if they are obvious from the description or their inference.

@vitorhcl
Copy link
Member

vitorhcl commented May 9, 2024

Thanks for your helpful comments @kbdharun . It is not a problem at all to revert changes in history.md file. Just one clarification question: What do you mean by that mnemonics are useful when there are multiple options to highlight or in translation? Also, isn't it generally helpful to indicate mnemonics in the description, whether or not the description implies the mnemonics? In fact, most of the mnemonics can be inferred by the associated options anyway, such as -r of rm -r for recursive, -f for rm -f for forcefully. But I still thought you should indicate them in the description even if they are obvious from the description or their inference.

I'm OK if the mnemonic change in history.md is reverted. However, I think they don't hurt (the length of the example description is the same); actually, I think there are some small benefits.

  1. Easier to understand if the example description is quite long or complex.
  2. Visually imediate association between thr mnemonic and the short options.
  3. Makes anyone who proposes a PR and its reviewers to pay attention to the mnemonic, not accidentally:
    • Removing the association between the keyword and the short option
    • Forgetting to use a placholder.
  4. Consitency with other pages with short options.
  5. Avoids case-by-case analyses which can originate more discussions and, IMO, unnecessary, delays for merging PRs (as I said earlier, the client will render it with the same length, after all)

@swoh816
Copy link
Contributor Author

swoh816 commented May 12, 2024

@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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
page edit Changes to an existing page(s).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants