You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hi, I noticed that most of the example commands in tldr documents use long options. I think this is inconsistent with my understanding. I think tldr-pages is a convenient tool to quickly familiarize yourself with commands. The example commands provided should be as short and easy to understand as possible. It doesn't make sense that the example commands always use long options!
The text was updated successfully, but these errors were encountered:
The reason why we use longform is to teach. A longform option conveys what the option does better. I forgot what contribution guideline file this reasoning was explained in.
Case by case we might use shortform like for example in pacman-sync because nobody uses pacman longform options or we might use {{-s|--longform}}. When only shortform option is available, we use mnemonics. https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md#option-syntax
I have made some ideas on how to make it user configurable to show either longform or shortform. I'm currently waiting for feedback from other members #15253
Hi, I noticed that most of the example commands in
tldr
documents use long options. I think this is inconsistent with my understanding. I thinktldr-pages
is a convenient tool to quickly familiarize yourself with commands. The example commands provided should be as short and easy to understand as possible. It doesn't make sense that the example commands always use long options!The text was updated successfully, but these errors were encountered: