diff options
| author | Chandan Singh <chandan@chandansingh.net> | 2020-02-22 18:17:36 +0000 |
|---|---|---|
| committer | Chandan Singh <chandan@chandansingh.net> | 2020-02-22 18:17:36 +0000 |
| commit | e624b2d791ee16e0a0a14c643904c3c0a4bad50c (patch) | |
| tree | 0085e6638c2a536ec9d6804f06d0409ffac2118c | |
| parent | d23cf67c6d0260e58342d17db0e2964084604ab4 (diff) | |
| download | buildstream-chandan/fix-bst-show-formatting.tar.gz | |
_frontend/cli.py: Fix formatting for `bst show` help textchandan/fix-bst-show-formatting
* 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.
| -rw-r--r-- | src/buildstream/_frontend/cli.py | 11 |
1 files 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 \\ |