From 8e31b9acd4c0dcd2e4d02626ee81fc58af6dc350 Mon Sep 17 00:00:00 2001 From: Lukas Holecek Date: Jun 26 2018 06:43:51 +0000 Subject: docs: Fix option reference Fixes Sphinx warning for an `:option:` reference: unknown option: --product-version --- diff --git a/docs/waiverdb-cli.rst b/docs/waiverdb-cli.rst index 3d539ff..9240ac4 100644 --- a/docs/waiverdb-cli.rst +++ b/docs/waiverdb-cli.rst @@ -18,35 +18,35 @@ ResultsDB, for recording waivers against). Options ======= -``-C, --config-file PATH`` +.. option:: -C, --config-file PATH Specify a config file to use. -``-r, --result-id INTEGER`` +.. option:: -r, --result-id INTEGER Specify one or more results to be waived. -``-s, --subject TEXT`` +.. option:: -s, --subject TEXT Specify one subject for a result to waive. -``-t, --testcase TEXT`` +.. option:: -t, --testcase TEXT Specify a testcase for the subject. -``-p, --product-version TEXT`` +.. option:: -p, --product-version TEXT Specify one of PDC's product version identifiers. -``--waived / --no-waived`` +.. option:: --waived, --no-waived Whether or not the result is waived. -``-c, --comment TEXT`` +.. option:: -c, --comment TEXT A comment explaining why the result is waived. -``-h, --help`` +.. option:: -h, --help Print usage help and exit.