From 68dbd9c70c2adf02dc84663beefebf46cb2f182b Mon Sep 17 00:00:00 2001
From: Mikhail Karnevskiy <mikhail.karnevskiy@xfel.eu>
Date: Tue, 9 Apr 2019 15:34:19 +0200
Subject: [PATCH] Update workflow.rst
---
docs/source/workflow.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/source/workflow.rst b/docs/source/workflow.rst
index f410c33f5..e08b36651 100644
--- a/docs/source/workflow.rst
+++ b/docs/source/workflow.rst
@@ -92,7 +92,7 @@ required::
cluster_profile = "noDB" # The ipcluster profile to use
local_output = False # output constants locally
-Here, `in_folder` and `out_folder` are required string values. Values for required parameters have to be given when executing from the command line. This means that any defaults given in the first cell of the code are ignored (they are only used to derive the type of the parameter). `Modules` is a list, which from the command line could also be assigned using a range expression, e.g. `5-10,12,13,18-21`, which would translate to `5,6,7,8,9,12,13,18,19,20`. It is also a required parameter. The parameter `local_output` is a Boolean. Corresponding argument given in the command line will change this parameter to `True`. There is not way to change this parameter from `True` to `False` from the command line.
+Here, `in_folder` and `out_folder` are required string values. Values for required parameters have to be given when executing from the command line. This means that any defaults given in the first cell of the code are ignored (they are only used to derive the type of the parameter). `Modules` is a list, which from the command line could also be assigned using a range expression, e.g. `5-10,12,13,18-21`, which would translate to `5,6,7,8,9,12,13,18,19,20`. It is also a required parameter. The parameter `local_output` is a Boolean. The corresponding argument given in the command line will change this parameter from `false` to `True`. There is not a way to change this parameter from `True` to `False` from the command line.
The `cluster_profile` parameter is a bit special, in that the tool kit expects exactly this
name to provide the profile name for an ipcluster_ being run. Hence you use `ipcluster`
--
GitLab