From bd648b7618e57ed2264eef12aa39b8999fe8779a Mon Sep 17 00:00:00 2001
From: Marc Egger <marc.egger@uzh.ch>
Date: Wed, 16 Sep 2020 16:51:04 +0200
Subject: [PATCH] small doku fix
---
Documentation/Report.rst | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/Documentation/Report.rst b/Documentation/Report.rst
index 3365712bb..c4b79b585 100644
--- a/Documentation/Report.rst
+++ b/Documentation/Report.rst
@@ -1412,17 +1412,17 @@ Run a php function defined in an external script.
* The second argument (here called $qfq) is an object which acts as an interface to QFQ functionality.
* The script has access to the following qfq functions using this interface:
* $qfq::apiCall($method, $url, $data = [], $header = [], $timeout = 5)
- * string $method PUT/POST/GET/DELETE
+ * string $method can be PUT/POST/GET/DELETE
* string $url
- * array $data json string, will be added as GET parameters or as POST fields respectively.
- * array $header of the form ['Content-type: text/plain', 'Content-length: 100']
- * int $timeout number of seconds to wait until call is aborted.
+ * array $data a json string which will be added as GET parameters or as POST fields respectively.
+ * array $header is of the form ['Content-type: text/plain', 'Content-length: 100']
+ * int $timeout is the number of seconds to wait until call is aborted.
* $qfq::getVar($key, $useStores = 'FSRVD', $sanitizeClass = '', &$foundInStore = '', $typeMessageViolate = 'c')
- * string $key name of qfq variable
- * string $useStores Stores in which variable is searched (in order from left to right). see :ref:`store`.
- * string $sanitizeClass see :ref:`sanitize-class`
+ * string $key is the name of qfq variable
+ * string $useStores are the stores in which variable is searched (in order from left to right). see :ref:`store`.
+ * string $sanitizeClass (see :ref:`sanitize-class`)
* string $foundInStore is filled with the name of the store in which the variable was found.
- * string $typeMessageViolate what to return if the sanitize class was violated:
+ * string $typeMessageViolate defines what to return if the sanitize class was violated:
* 'c': return '!!<sanitize class>!!'
* '0': return '0'
* 'e': return ''
--
GitLab