From 8edf4822b262f7a886382a42c6dff1a7c84ff7bf Mon Sep 17 00:00:00 2001 From: Chandan Singh Date: Sat, 22 Feb 2020 18:17:36 +0000 Subject: _frontend/cli.py: Fix formatting for `bst show` help text * Sphinx does not allow sections within docstrings so convert the "FORMAT" heading into bold text. See https://sphinx-dev.narkive.com/7rqrxjgL/headings-in-docstrings for some related discussion on this issue. * Sphinx uses double backticks for code samples so fix that for CLI options. * Fix a typo. Fixes #323. --- src/buildstream/_frontend/cli.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/src/buildstream/_frontend/cli.py b/src/buildstream/_frontend/cli.py index 52848ca2e..44bb99f92 100644 --- a/src/buildstream/_frontend/cli.py +++ b/src/buildstream/_frontend/cli.py @@ -546,7 +546,7 @@ def show(app, elements, deps, except_, order, format_): By default this will show all of the dependencies of the specified target element. - Specify `--deps` to control which elements to show: + Specify ``--deps`` to control which elements to show: \b none: No dependencies, just the element itself @@ -555,10 +555,9 @@ def show(app, elements, deps, except_, order, format_): build: Build time dependencies, excluding the element itself all: All dependencies - \b - FORMAT - ~~~~~~ - The --format option controls what should be printed for each element, + **FORMAT** + + The ``--format`` option controls what should be printed for each element, the following symbols can be used in the format string: \b @@ -578,7 +577,7 @@ def show(app, elements, deps, except_, order, format_): The value of the %{symbol} without the leading '%' character is understood as a pythonic formatting string, so python formatting features apply, - examle: + example: \b bst show target.bst --format \\ -- cgit v1.2.1