ashley/tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2024-10-28 08:59:45 +01:00
Code Activity

style-guide: readd guidelines for --opt arg (#14383)

Browse source 
#10906 again, this line was removed for some reason.
This commit is contained in:
Lena 2024-10-26 02:53:18 +02:00 committed by GitHub
parent 02795424a3
commit 379a6e4388
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 1 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
contributing-guides/style-guide.md
View file

@ -395,6 +395,7 @@ For example, `[d]ownload` in English may be translated into `[d]escargar` in Spa
- For commonly/frequently used commands (e.g. `grep`, `tar`, `etc`), we prefer using short options along with [mnemonics](#short-option-mnemonics) or both inside a placeholder.
- For highlighting both long and short options in commands (instead of using mnemonics), combine them within a placeholder i.e. `{{-o|--output}}`.
- For user-friendliness, use **GNU-style long options** (like `--help` rather than `-h`) when they are cross-platform compatible (intended to work the same across multiple platforms) for pages in the `common` directory.
- Prefer using a space instead of the equals sign (`=`) to separate options from their arguments (i.e. use `--opt arg` instead of `--opt=arg`), unless the program does not support it.
### Placeholder syntax