From c686b7cf4b13f89dc91fd14faa866f2bad1c6d05 Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Fri, 21 Aug 2020 12:14:25 +0200
Subject: [PATCH] docs(*): Add versionadded directives where applicable
Signed-off-by: Rahix <rahix@rahix.de>
---
epicardium/epicardium.h | 4 ++--
pycardium/modules/py/leds.py | 2 +-
pycardium/modules/py/max86150.py | 2 ++
3 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/epicardium/epicardium.h b/epicardium/epicardium.h
index 2ad191349..3e1df5787 100644
--- a/epicardium/epicardium.h
+++ b/epicardium/epicardium.h
@@ -970,7 +970,7 @@ struct max86150_sensor_data {
* - ``-EINVAL``: config->ppg_sample_rate is not one of 10, 20, 50, 84, 100, 200
* or config_size is not size of config.
*
- * .. versionadded:: 1.13
+ * .. versionadded:: 1.16
*/
API(API_MAX86150_ENABLE, int epic_max86150_enable_sensor(struct max86150_sensor_config *config, size_t config_size));
@@ -979,7 +979,7 @@ API(API_MAX86150_ENABLE, int epic_max86150_enable_sensor(struct max86150_sensor_
*
* :returns: 0 in case of success or forward negative error value from stream_deregister.
*
- * .. versionadded:: 1.13
+ * .. versionadded:: 1.16
*/
API(API_MAX86150_DISABLE, int epic_max86150_disable_sensor());
diff --git a/pycardium/modules/py/leds.py b/pycardium/modules/py/leds.py
index db09834cc..043cef19f 100644
--- a/pycardium/modules/py/leds.py
+++ b/pycardium/modules/py/leds.py
@@ -104,7 +104,7 @@ def flash_rocket(led, value, millis):
:param int value: brightness value (0 < value < 32)
:param int millis: duration of the rocket being on in milliseconds.
- .. versionadded:: 1.??
+ .. versionadded:: 1.16
"""
return sys_leds.flash_rocket(led, value, millis)
diff --git a/pycardium/modules/py/max86150.py b/pycardium/modules/py/max86150.py
index c52665c90..6040eed0a 100644
--- a/pycardium/modules/py/max86150.py
+++ b/pycardium/modules/py/max86150.py
@@ -22,6 +22,8 @@ class MAX86150:
print("Red: {} Infrared: {} ECG: {}", sample.red, sample.infrared, sample.ecg)
m.close()
+
+ .. versionadded:: 1.16
"""
def __init__(self, callback=None, sample_buffer_len=128, sample_rate=200):
--
GitLab