Skip to content

Commit

Permalink
Formal docs fixes
Browse files Browse the repository at this point in the history
Details:

* Changed headings containing option names, or names of command groups
  or commands, to show these names in monospaced font.

* Changed plain mentioning of general options to become references to
  the respective headings, but only for the first occurrence in a section.

* Changed mentioning of command options and command group names and command
  names to monospaced font.

* Minor editorial fixes of text.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
  • Loading branch information
andy-maier committed Jun 13, 2020
1 parent f39ee84 commit 5ef1715
Show file tree
Hide file tree
Showing 6 changed files with 267 additions and 294 deletions.
5 changes: 3 additions & 2 deletions docs/appendix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ This documentation uses a few special terms to refer to Python types:
in the current directory. Multiple connections files may exist in
different directories. This allows connection definitions to be
predefined and pywbemcli commands executed against them using only the
connection definition name (via the ``--name`` general option).
connection definition name (via the :ref:`--name general option`).

MOF
MOF (Managed Object Format) is the language used by the DMTF to
Expand Down Expand Up @@ -177,7 +177,8 @@ This documentation uses a few special terms to refer to Python types:
the default connection is defined.
A connection definition in the :term:`connections file` becomes the
default connection on pywbemcli startup if it is specified using the
:ref:`connection select command` and the ``--default option`` is used.
:ref:`connection select command` and the
``--default``/``-d`` command option is used.

current connection
The connection definition in pywbemcli that is currently active; it is the
Expand Down
4 changes: 2 additions & 2 deletions docs/pywbemcli/cmdlineinterface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ begin with ``-``.
Command groups are named after the objects the commands operate on
(ex. ``class``, ``instance``, ``qualifier``, ``server``). Executing

.. code-block::text
.. code-block:: text
$ pywbemcli --help
...
Expand Down Expand Up @@ -427,7 +427,7 @@ Pywbemcli terminates with one of the following program exit codes:

These Python tracebacks should never happen and are always considered a
reason to open a bug in the
`pywbemtools issue tracker <https://github.com/pywbem/pywbemtools/issues>`_`.
`pywbemtools issue tracker <https://github.com/pywbem/pywbemtools/issues>`_.

Note that an error message with a traceback from a mock Python script does
not fall into this category and is an issue in that Python script and not
Expand Down
Loading

0 comments on commit 5ef1715

Please sign in to comment.