feat(commitizen): document '--' double dash in '--help'

Signed-off-by: Adrian DC <[email protected]>

Author: AdrianDC

commitizen/cli.py

@@ -162,6 +162,12 @@ def __call__(
                         "default": 0,
                         "help": "length limit of the commit message; 0 for no limit",
                     },
+                    {
+                        "name": ["--"],
+                        "action": "store_true",
+                        "dest": "double_dash",
+                        "help": "Positional arguments separator (recommended)",
+                    },
                 ],
             },
             {

tests/commands/test_commit_command/test_commit_command_shows_description_when_use_help_option.txt

@@ -1,6 +1,6 @@
 usage: cz commit [-h] [--retry] [--no-retry] [--dry-run]
                  [--write-message-to-file FILE_PATH] [-s] [-a]
-                 [-l MESSAGE_LENGTH_LIMIT]
+                 [-l MESSAGE_LENGTH_LIMIT] [--]
 
 create new commit
 
@@ -18,3 +18,4 @@ options:
                         not told Git about are not affected.
   -l, --message-length-limit MESSAGE_LENGTH_LIMIT
                         length limit of the commit message; 0 for no limit
+  --                    Positional arguments separator (recommended)