From 81ca40d181a47332b0c035b8bf9f0ae1633383b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20J=C3=A4hn?= Date: Wed, 7 Feb 2024 10:35:05 +0100 Subject: [PATCH] Change some variable descriptions --- docs/config.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/config.rst b/docs/config.rst index 4bf22ee8..39a34808 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -64,13 +64,13 @@ This is a non-exhaustive list containing the most important configuration variab +------------------------+-------------------------------------------------------------------------+ | ``user_mail`` | The user's email address, determined based on system configuration. | +------------------------+-------------------------------------------------------------------------+ -|| ``user_name`` || The username of the current user, obtained from the ``$USER`` | -|| || environment variable. | +|| ``user_name`` || Your email address to receive notifications. Either provide it | +|| || directly here or in ``~/.forward``. | +------------------------+-------------------------------------------------------------------------+ | ``workflow`` | The name of the workflow from ``workflows.yaml`` or a self-defined one. | +------------------------+-------------------------------------------------------------------------+ -|| ``work_root`` || The root directory for processing chain execution, typically located | -|| || under the source directory. | +|| ``work_root`` || The working directory where all output is stored. Should be somewhere | +|| || on ``$SCRATCH$``. By default, it is set to ``/work``. | +------------------------+-------------------------------------------------------------------------+