CLI: Display output format choices within crash --help

Previously, it was not easy to discover which value to supply to the `--format` command-line argument of `crash`.
crate · Nov 23, 2023 · 7f7ab2e · 7f7ab2e
1 parent 0c80dfc
commit 7f7ab2e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -5,6 +5,8 @@ Changes for crash
 Unreleased
 ==========
 
+- CLI: Added possible output format choices for ``--format`` argument to
+  ``crash --help``. Thanks, @mfussenegger.
 
 2023/07/06 0.30.0
 =================

diff --git a/crate/crash/command.py b/crate/crash/command.py
@@ -155,7 +155,8 @@ def _conf_or_default(key, value):
     parser.add_argument('--format', type=str,
                         default=_conf_or_default('format', 'tabular'),
                         choices=output_formats, metavar='FORMAT',
-                        help='the output FORMAT of the SQL response')
+                        help=f'the output FORMAT of the SQL response.\n'
+                             f'choose one of: {", ".join(output_formats)}')
     parser.add_argument('--version', action='store_true', default=False,
                         help='print the Crash version and exit')