From 6a0b9dbf84da24a9ea2d4e9eef68802b3eaae882 Mon Sep 17 00:00:00 2001 From: Managor <42655600+Managor@users.noreply.github.com> Date: Sun, 9 Feb 2025 05:18:16 +0200 Subject: [PATCH] style-guide: clarify shortform option style (#15703) --- contributing-guides/style-guide.md | 1 + 1 file changed, 1 insertion(+) diff --git a/contributing-guides/style-guide.md b/contributing-guides/style-guide.md index dc2fddb763..6465c717f6 100644 --- a/contributing-guides/style-guide.md +++ b/contributing-guides/style-guide.md @@ -395,6 +395,7 @@ For example, `[d]ownload` in English may be translated into `[d]escargar` in Spa - 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. +- Likewise prefer separating shortform options from their arguments with a space (i.e. use `-o arg` instead of `-oarg`), unless the program does not support it. ### Placeholder syntax