From b9fbbc1f07d0a3532f75df1dd3e6f300bce8697c Mon Sep 17 00:00:00 2001 From: Nadja Brix Koch Date: Tue, 4 Aug 2026 11:05:40 +0200 Subject: [PATCH] fix(docs/config): use correct format for env config The format of the example code was not valid TOML, confusing users. Also, I added an "optionally" to the sentence to clarify that this key is not necessary to make cijoe run. Signed-off-by: Nadja Brix Koch --- docs/source/configs/index.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/source/configs/index.rst b/docs/source/configs/index.rst index 78f64f45..89de5389 100644 --- a/docs/source/configs/index.rst +++ b/docs/source/configs/index.rst @@ -114,15 +114,16 @@ Shell Configuration ``cijoe.run.env`` ~~~~~~~~~~~~~~~~~ -It is possible to set up environment variables for the **target** system. All -calls to ``cijoe.run(...)`` will be given the environment variables defined by -this configuration option. +Optionally, it is possible to set up environment variables for the **target** +system. All calls to ``cijoe.run(...)`` will be given the environment variables +defined by this configuration option. Example: -.. code-block:: ini +.. code-block:: toml - cijoe.run.env = PATH=/usr/local/bin:/usr/bin, LANG=en_US.UTF-8 + [cijoe.run] + env = { PATH = "/usr/local/bin:/usr/bin", LANG = "en_US.UTF-8" } In this example, any command run through ``cijoe.run(...)`` will use the specified ``PATH`` and ``LANG`` variables.