From 578e4c3b3034f16fb2c9a284fe0f0ac0c100657d Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Wed, 11 Dec 2019 13:29:18 +0100 Subject: [PATCH] doc: markup envvars as such, HANDLER_ID as variable MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit HANDLER_ID represents a variable name in this case, and the docs¹, first Note, suggest using the default role (`content`) for variable names. ¹: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html Co-authored-by: Roberto Abdelkader Martínez Pérez --- docs/source/concepts/request_life_cycle.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/concepts/request_life_cycle.rst b/docs/source/concepts/request_life_cycle.rst index 2df815f..468e8a5 100644 --- a/docs/source/concepts/request_life_cycle.rst +++ b/docs/source/concepts/request_life_cycle.rst @@ -14,8 +14,8 @@ The user makes a request to the `User HTTP Interface`. - The request is matched against the route table. -- :program:`kapow` provides a `HANDLER_ID` to identify this request and don't mix it - with other requests that could be running concurrently. +- :program:`kapow` provides a `HANDLER_ID` to identify this request and don't + mix it with other requests that could be running concurrently. 2. spawn @@ -29,9 +29,9 @@ The default entrypoint is ``/bin/sh``; let's focus on this workflow. The spawned entrypoint is run with the following variables added to its environment: -- ``KAPOW_HANDLER_ID``: Containing the `HANDLER_ID` -- ``KAPOW_DATAAPI_URL``: With the URL of the `Data HTTP Interface` -- ``KAPOW_CONTROLAPI_URL``: With the URL of the `Control HTTP Interface` +- :envvar:`KAPOW_HANDLER_ID`: Containing the `HANDLER_ID` +- :envvar:`KAPOW_DATAAPI_URL`: With the URL of the `Data HTTP Interface` +- :envvar:`KAPOW_CONTROLAPI_URL`: With the URL of the `Control HTTP Interface` 3. ``kapow set /response/body banana``