correct default in documentation #834

MetPX · Nov 18, 2023 · 7443ebc · 7443ebc
1 parent aaa71fe
commit 7443ebc
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 6 deletions.
diff --git a/docs/source/Explanation/CommandLineGuide.rst b/docs/source/Explanation/CommandLineGuide.rst
@@ -300,7 +300,7 @@ View all configuration settings (the result of all parsing... what the flow comp
      'feeder': ParseResult(scheme='amqp', netloc='tfeed@localhost', path='/', params='', query='', fragment=''),
      'fileEvents': {'create', 'link', 'modify', 'delete', 'mkdir', 'rmdir' },
      'file_total_interval': '0',
-     'filename': 'WHATFN',
+     'filename': None,
      'fixed_headers': {},
      'flatten': '/',
      'hostdir': 'fractal',

diff --git a/docs/source/Reference/sr3_options.7.rst b/docs/source/Reference/sr3_options.7.rst
@@ -121,8 +121,11 @@ In the rename option, the time to be substituted is one hour in the past.
 One can also specify variable substitutions to be performed on arguments to the directory
 option, with the use of *${..}* notation:
 
-* %...     - a `datetime.strftime() <https://docs.python.org/3/library/datetime.html#datetime.date.strftime>`_ compatible date/time formatting string augmented by an offset duration suffix (- for in the past, + for in the future)
-  example:  ${%Y/%m/%d_%Hh%M:%S.%f} --> 2022/12/04_17h36:34.014412 
+* %...     - a `datetime.strftime() <https://docs.python.org/3/library/datetime.html#datetime.date.strftime>`_ compatible date/time formatting string augmented by an offset duration prefix (- for in the past, + for in the future)
+
+  * example (complex date):  ${%Y/%m/%d_%Hh%M:%S.%f} --> 2022/12/04_17h36:34.014412 
+  * example (add offset):  ${%o-1h%Y/%m/%d_%Hh%M:%S.%f} --> 2022/12/04_16h36:34.014412 
+
 * SOURCE   - the amqp user that injected data (taken from the notification message.)
 * BD       - the base directory
 * BUP      - the path component of the baseUrl (or: baseUrlPath) 
@@ -738,7 +741,7 @@ and in early use (when default was 1 week) brokers would often get overloaded wi
 long queues for left-over experiments.
 
 
-filename <keyword> (default:WHATFN)
+filename <keyword> (default:None)
 -----------------------------------
 
 From **metpx-sundew**, the support of this option give all sorts of possibilities

diff --git a/docs/source/fr/Explication/GuideLigneDeCommande.rst b/docs/source/fr/Explication/GuideLigneDeCommande.rst
@@ -2477,7 +2477,7 @@ pour la livraison du produit. Le script reçoit une instance de la classe sender
 Le script prends le parent comme argument, et par exemple, une
 modification de **parent.msg.new_file** changera le nom du fichier écrit localement.
 
-filename <mots-clé> (défaut:WHATFN)
+filename <mots-clé> (défaut:None)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 De **MetPX Sundew**, le support de cette option donne toutes sortes de possibilités

diff --git a/docs/source/fr/Reference/sr3_options.7.rst b/docs/source/fr/Reference/sr3_options.7.rst
@@ -727,7 +727,7 @@ assigné au courtier, et dans les premières utilisations (lorsque le défaut é
 étaient souvent surchargés de très longues files d’attente pour les tests restants.
 
 
-filename <mots-clé> (défaut:WHATFN)
+filename <mots-clé> (défaut:None)
 -----------------------------------
 
 De **MetPX Sundew**, le support de cette option donne toutes sortes de possibilités