Fix docstrings RST markup in `ansible-console` CLI module (#80719)

* 📝🐛 Fix RST list @ `ansible-console` manpage

Said CLI entrypoint docstring is used to construct the corresponding
manpage. `docutils` were producing the following warning with the
current RST markup used there, as follows:

  :36: (WARNING/2) Bullet list ends without a blank line; unexpected unindent.

This change puts a portion of the first list entry on a separate line
which allows the RST parser stomach it without any problems and
produce correct output without gibberish in it.

* 🎨📝 Use RST inline code @ ansible-console doc

The single backtick syntax was causing things to be interpreted as
italics text. The inline code needs double backticks.
pull/80723/head
Sviatoslav Sydorenko 1 year ago committed by GitHub
parent 8cd95a8e66
commit 2b6d5536d7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -39,26 +39,30 @@ class ConsoleCLI(CLI, cmd.Cmd):
''' '''
A REPL that allows for running ad-hoc tasks against a chosen inventory A REPL that allows for running ad-hoc tasks against a chosen inventory
from a nice shell with built-in tab completion (based on dominis' from a nice shell with built-in tab completion (based on dominis'
ansible-shell). ``ansible-shell``).
It supports several commands, and you can modify its configuration at It supports several commands, and you can modify its configuration at
runtime: runtime:
- `cd [pattern]`: change host/group (you can use host patterns eg.: app*.dc*:!app01*) - ``cd [pattern]``: change host/group
- `list`: list available hosts in the current path (you can use host patterns eg.: ``app*.dc*:!app01*``)
- `list groups`: list groups included in the current path - ``list``: list available hosts in the current path
- `become`: toggle the become flag - ``list groups``: list groups included in the current path
- `!`: forces shell module instead of the ansible module (!yum update -y) - ``become``: toggle the become flag
- `verbosity [num]`: set the verbosity level - ``!``: forces shell module instead of the ansible module
- `forks [num]`: set the number of forks (``!yum update -y``)
- `become_user [user]`: set the become_user - ``verbosity [num]``: set the verbosity level
- `remote_user [user]`: set the remote_user - ``forks [num]``: set the number of forks
- `become_method [method]`: set the privilege escalation method - ``become_user [user]``: set the become_user
- `check [bool]`: toggle check mode - ``remote_user [user]``: set the remote_user
- `diff [bool]`: toggle diff mode - ``become_method [method]``: set the privilege escalation method
- `timeout [integer]`: set the timeout of tasks in seconds (0 to disable) - ``check [bool]``: toggle check mode
- `help [command/module]`: display documentation for the command or module - ``diff [bool]``: toggle diff mode
- `exit`: exit ansible-console - ``timeout [integer]``: set the timeout of tasks in seconds
(0 to disable)
- ``help [command/module]``: display documentation for
the command or module
- ``exit``: exit ``ansible-console``
''' '''
name = 'ansible-console' name = 'ansible-console'

Loading…
Cancel
Save