reStructuredText format for docstrings of sensorid and sensortype.
authorPhilipp Spitzer <philipp@spitzer.priv.at>
Tue, 26 Feb 2019 21:18:04 +0000 (22:18 +0100)
committerPhilipp Spitzer <philipp@spitzer.priv.at>
Tue, 26 Feb 2019 21:18:04 +0000 (22:18 +0100)
web/seepark_web.py

index 890e68126c47170626337d1bc0425a577f83fbcc..1ff515138a159df48396c238a723fc4ef66cdc4d 100644 (file)
@@ -307,10 +307,11 @@ def sensorid(version, sensor_id):
     """Return all data for a specific sensor
 
     URL parameters:
     """Return all data for a specific sensor
 
     URL parameters:
-    begin=<datetime>, optional, format like "2018-05-19T21:07:53"
-    end=<datetime>, optional, format like "2018-05-19T21:07:53"
-    mode=<full|consolidated>, optional. return all rows (default) or with lower resolution (for charts)
-    format=<default|c3>, optional. return result as returned by sqlalchemy (default) or formatted for c3.js
+
+    * ``begin=<datetime>``, optional, format like ``2018-05-19T21:07:53``
+    * ``end=<datetime>``, optional, format like ``2018-05-19T21:07:53``
+    * ``mode=<full|consolidated>``, optional. return all rows (default) or with lower resolution (for charts)
+    * ``format=<default|c3>``, optional. return result as returned by sqlalchemy (default) or formatted for c3.js
     """
     result = sensordata(sensor_id=sensor_id)
     return jsonify(result)
     """
     result = sensordata(sensor_id=sensor_id)
     return jsonify(result)
@@ -321,10 +322,11 @@ def sensortype(version, sensor_type):
     """Return all data for a specific sensor type
 
     URL parameters:
     """Return all data for a specific sensor type
 
     URL parameters:
-    begin=<datetime>, optional, format like "2018-05-19T21:07:53"
-    end=<datetime>, optional, format like "2018-05-19T21:07:53"
-    mode=<full|consolidated>, optional. return all rows (default) or with lower resolution (for charts)
-    format=<default|c3>, optional. return result as returned by sqlalchemy (default) or formatted for c3.js
+
+    * ``begin=<datetime>``, optional, format like ``2018-05-19T21:07:53``
+    * ``end=<datetime>``, optional, format like ``2018-05-19T21:07:53``
+    * ``mode=<full|consolidated>``, optional. return all rows (default) or with lower resolution (for charts)
+    * ``format=<default|c3>``, optional. return result as returned by sqlalchemy (default) or formatted for c3.js
     """
     result = sensordata(sensor_type=sensor_type)
     return jsonify(result)
     """
     result = sensordata(sensor_type=sensor_type)
     return jsonify(result)