Display argument name where exist

Signed-off-by: Bernát Gábor <[email protected]>

Author: gaborbernat

.github/workflows/check.yml

@@ -52,15 +52,6 @@ jobs:
           PYTEST_ADDOPTS: "-vv --durations=20"
           CI_RUN: "yes"
           DIFF_AGAINST: HEAD
-      - name: rename coverage report file
-        run: |
-          import os; os.rename('.tox/coverage.{}.xml'.format(os.environ['TOXENV']), '.tox/coverage.xml')
-        shell: python
-      - uses: codecov/codecov-action@v1
-        with:
-          file: ./.tox/coverage.xml
-          flags: tests
-          name: ${{ matrix.py }} - ${{ matrix.os }}
 
   check:
     name: check ${{ matrix.tox_env }} - ${{ matrix.os }}

CHANGELOG.md

@@ -2,7 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
-## 1.4.0 (2021-02-14)
+## 1.5.0 (2021-02-13)
+
+- Display the metavar (fallback to dest) if the action has more than one argument (this is inline with how usage is
+  displayed).
+
+## 1.4.0 (2021-02-13)
 
 - Command line arguments are now bold to highlight them even further from the help text
 
@@ -12,7 +17,8 @@ All notable changes to this project will be documented in this file.
 - Mark document as always needs update (as the underlying content is coming from outside the sphinx documents)
 - Help messages is now interpreted as reStructuredText
 - Matching curly braces, single and double quotes in help text will be marked as string literals
-- Help messages containing the ``default(s)`` word do not show the default value (as often this indicates the default is already documented in the help text)
+- Help messages containing the `default(s)` word do not show the default value (as often this indicates the default is
+  already documented in the help text)
 
 ## 1.2.0 (2021-02-05)
 

README.md

@@ -6,7 +6,6 @@
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/sphinx-argparse-cli?style=flat-square)](https://pypistats.org/packages/sphinx-argparse-cli)
 [![PyPI - License](https://img.shields.io/pypi/l/sphinx-argparse-cli?style=flat-square)](https://opensource.org/licenses/MIT)
 ![check](https://github.com/gaborbernat/sphinx-argparse-cli/workflows/check/badge.svg?branch=main)
-[![codecov](https://codecov.io/gh/gaborbernat/sphinx-argparse-cli/branch/main/graph/badge.svg)](https://codecov.io/gh/pypa/virtualenv)
 [![Code style:
 black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black)
 

roots/test-complex/parser.py

@@ -7,6 +7,8 @@ def make() -> ArgumentParser:
     parser = ArgumentParser(description="argparse tester", prog="complex")
     parser.add_argument("--root", action="store_true", help="root flag")
     parser.add_argument("--no-help", action="store_true")
+    parser.add_argument("--outdir", "-o", type=str, help="output directory", metavar="out_dir")
+    parser.add_argument("--in-dir", "-i", type=str, help="input directory", dest="in_dir")
 
     group = parser.add_argument_group("Exclusive", description="this is an exclusive group")
     exclusive = group.add_mutually_exclusive_group()

src/sphinx_argparse_cli/_logic.py

@@ -139,20 +139,22 @@ def _mk_option_group(self, group: _ArgumentGroup, prefix: str) -> section:
 
     def _mk_option_line(self, action: Action, prefix: str) -> list_item:  # noqa
         line = paragraph()
+        as_key = action.dest
+        if action.metavar:
+            as_key = action.metavar if isinstance(action.metavar, str) else action.metavar[0]
         if action.option_strings:
             first = True
+            is_flag = action.nargs == 0
             for opt in action.option_strings:
                 if first:
                     first = False
                 else:
                     line += Text(", ")
                 self._mk_option_name(line, prefix, opt)
+                if not is_flag:
+                    line += Text(" ")
+                    line += literal(text=as_key.upper())
         else:
-            as_key = (
-                action.dest
-                if action.metavar is None
-                else (action.metavar if isinstance(action.metavar, str) else action.metavar[0])
-            )
             self._mk_option_name(line, prefix, as_key)
 
         point = list_item("", line, ids=[])

tests/complex.txt

@@ -3,7 +3,8 @@ complex - CLI interface
 
 argparse tester
 
-   complex [-h] [--root] [--no-help] [--foo | --bar] {first,f,second,third} ...
+   complex [-h] [--root] [--no-help] [--outdir out_dir] [--in-dir IN_DIR] [--foo | --bar]
+           {first,f,second,third} ...
 
 
 optional arguments
@@ -15,6 +16,12 @@ optional arguments
 
 * **"--no-help"** (default: "False")
 
+* **"--outdir"** "OUT_DIR", **"-o"** "OUT_DIR" - output directory
+  (default: "None")
+
+* **"--in-dir"** "IN_DIR", **"-i"** "IN_DIR" - input directory
+  (default: "None")
+
 
 Exclusive
 =========