Taiga 1227 (24626): adds parameter information to the automatic_renewal cron job...
authorCaroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com>
Mon, 22 Jun 2020 21:05:12 +0000 (17:05 -0400)
committerCaroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com>
Tue, 23 Jun 2020 18:14:39 +0000 (18:14 +0000)
source/cron_jobs.rst

index 5ab8936..d47ad7f 100644 (file)
@@ -333,6 +333,26 @@ renewal with your :ref:`circulation and fines rules <circulation-and-fines-rules
 
 Frequency suggestion: nightly
 
+    **Important**
+    To run this properly, you must use the --confirm parameter, otherwise it 
+    will only run in test mode
+
+    **PARAMETERS**
+    -  -h|--help
+       get help message
+
+    -  --send-notices
+       sends the AUTO_RENEWALS notice to patrons if the automatic renewal has 
+       been done
+
+    -  -v|--verbose
+       verbose mode
+
+    -  -c|--confirm
+       without this parameter no changes will be made, the script will run in 
+       test mode
+       without this parameter, the script will default to verbose mode as well
+
 .. _cron-patrons-label:
 
 Patrons