From 6958197b998e574bb5fe101da2dfb4fef1ad87e1 Mon Sep 17 00:00:00 2001
From: asetGem <amandine.perrin@pasteur.fr>
Date: Sun, 1 Aug 2021 19:02:55 +0200
Subject: [PATCH] avoid using "" in config file string parameters
---
doc/source/usage.rst | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/doc/source/usage.rst b/doc/source/usage.rst
index 8463f60a..4f9f3095 100755
--- a/doc/source/usage.rst
+++ b/doc/source/usage.rst
@@ -71,7 +71,6 @@ Configfile has the following format:
.. code-block:: text
[module]
- param1 = "test"
param2 = test
param3= True
param4 =yes
@@ -83,7 +82,7 @@ Where:
- `module` corresponds to the module for which you want to give a parameter (`prepare`, `annotate`, `pangenome`, `corepers`, `align`, `tree`).
- a boolean parameter is set with one of the boolean values (case-insensitive): 'yes'/'no', 'on'/'off', 'true'/'false' or '1'/'0' (examples with `param3`, `param4` and `param5` which are all booleans with True value)
- - `""` are not mandatory for str arguments: `param1` and `param2` are the same.
+ - `""` around strings will be removed. It is better to avoid using them (ex: `param2 = test` instead of `param2 = "test"`)
- Use `#` to comment a line (information after a `#` will not be taken into account by the parser).
- Use `:` or `=` to delimit argument names from values
--
GitLab