doc: fix typo and rst style fixes

As per the official docs¹, we should use ``code`` instead of :samp:`code`,
since we are not enhancing variables inside.

:samp:
A piece of literal text, such as code. Within the contents, you can use curly
braces to indicate a “variable” part, as in file. For example, in :samp:`print
1+{variable}`, the part variable would be emphasized.

If you don’t need the “variable part” indication, use the standard ``code``
instead.

¹: https://www.sphinx-doc.org/en/1.5/markup/inline.html#role-samp
This commit is contained in:
pancho horrillo
2019-12-11 02:37:56 +01:00
parent 16639ba44b
commit e6cb0f1fa6
2 changed files with 20 additions and 20 deletions
+3 -3
View File
@@ -123,7 +123,7 @@ You can list the active routes in the *Kapow!* server.
$ kapow route list
[{"id":"20c98328-0b82-11ea-90a8-784f434dfbe2","method":"GET","url_pattern":"/echo/{message}","entrypoint":"/bin/sh -c","command":"kapow get /request/matches/message | kapow set /response/body"}]
Or, if you want human-readable output, you can use :samp:`jq`:
Or, if you want human-readable output, you can use ``jq``:
.. code-block:: console
:linenos:
@@ -175,7 +175,7 @@ If you need to write more complex actions, you can leverage multiline commands:
.. warning::
Be aware of the **"-"** at the end of the ``kapow route add`` command.
It tells ``kapow route add`` to read commands from :samp:`stdin`.
It tells ``kapow route add`` to read commands from ``stdin``.
.. warning::
@@ -482,7 +482,7 @@ In this example we'll redirect our users to Google:
How to Execute Two Processes in Parallel
++++++++++++++++++++++++++++++++++++++++
We want to :samp:`ping` two machines parallel. *Kapow!* can get IPs from query
We want to ``ping`` two machines parallel. *Kapow!* can get IPs from query
params:
.. code-block:: console