From 7f4c95ea609e52c8d469a9a23a6ed1a4ec85fb57 Mon Sep 17 00:00:00 2001 From: Managor <42655600+Managor@users.noreply.github.com> Date: Tue, 24 Jun 2025 19:19:08 +0300 Subject: [PATCH] style-guide: reorganize mnemonic guide (#16955) --- contributing-guides/style-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing-guides/style-guide.md b/contributing-guides/style-guide.md index b60bb36031..2fbec32fe1 100644 --- a/contributing-guides/style-guide.md +++ b/contributing-guides/style-guide.md @@ -424,8 +424,8 @@ For example, `[d]ownload` in English may be translated into `[d]escargar` in Spa ### Option syntax - For user-friendliness, prefer **GNU-style long options** (like `--help` rather than `-h`). Make sure that the options are cross-platform compatible (intended to work the same across multiple platforms) for pages in the `common` directory. -- If a command only supports short options or the short option greatly differs from the long option, attempt to document what the letter is short for with a [mnemonic](#short-option-mnemonics). - For letting the client decide whether to show long or short options in commands, use an option placeholder i.e. `{{[-o|--output]}}`. +- If a command only supports short options or the short option greatly differs from the long option, attempt to document what the letter is short for with a [mnemonic](#short-option-mnemonics). - Prefer grouping flag options together when the program supports it (i.e. `{{[-it|--interactive --tty]}}` instead of `{{[-i|--interactive]}} {{[-t|--tty]}}`). - Prefer not grouping options that take in arguments (i.e. `{{[-it|--interactive --tty]}} {{[-w|--workdir]}} {{path/to/directory}}` instead of `{{[-itw|--interactive --tty --workdir]}} {{path/to/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.