Merge branch 'doc/bool_param' into 'master'

Extend description of boolean variables

See merge request detectors/pycalibration!58

docs/source/workflow.rst

@@ -90,9 +90,9 @@ required::
     runs = [820,] # runs to use, required, range allowed
     sequences = [0,1,2,3,4] # sequences files to use, range allowed
     cluster_profile = "noDB" # The ipcluster profile to use
-    local_output = True # output constants locally
+    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. 
+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 no 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`
@@ -131,6 +131,9 @@ to the following parameters being exposed via the command line::
                             Default: [0, 1, 2, 3, 4]
       --cluster-profile str
                             The ipcluster profile to use. Default: noDB2
+
+      --local-output        output constants locally. Default: False
+
     ...