From dfcac714adbcde8567529725d917e18705a3d826 Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Mon, 9 Dec 2019 21:15:25 +0100
Subject: [PATCH] docs: Mark new APIs for version 1.13
Signed-off-by: Rahix <rahix@rahix.de>
---
Documentation/pycardium/utime.rst | 4 ++++
epicardium/epicardium.h | 6 ++++++
pycardium/modules/py/simple_menu.py | 2 ++
3 files changed, 12 insertions(+)
diff --git a/Documentation/pycardium/utime.rst b/Documentation/pycardium/utime.rst
index b28d7b11..03d333b2 100644
--- a/Documentation/pycardium/utime.rst
+++ b/Documentation/pycardium/utime.rst
@@ -52,6 +52,8 @@ alarm.
This function should be the preferred method for timing and profiling
because it does not need an API call and thus is very fast.
+ .. versionadded:: 1.13
+
.. py:function:: ticks_us()
Return processor ticks (converted to microseconds) since Pycardium startup.
@@ -59,6 +61,8 @@ alarm.
This function should be the preferred method for timing and profiling
because it does not need an API call and thus is very fast.
+ .. versionadded:: 1.13
+
.. py:function:: unix_time()
Return the current unix time as seconds since the epoch.
diff --git a/epicardium/epicardium.h b/epicardium/epicardium.h
index 05d56582..01709785 100644
--- a/epicardium/epicardium.h
+++ b/epicardium/epicardium.h
@@ -1942,6 +1942,8 @@ API(API_WS2812_WRITE, void epic_ws2812_write(uint8_t pin, uint8_t *pixels, uint3
* errors:
*
* - ``-ENOENT``: Value can not be read
+ *
+ * .. versionadded:: 1.13
*/
API(API_CONFIG_GET_INTEGER, int epic_config_get_integer(const char *key, int *value));
@@ -1954,6 +1956,8 @@ API(API_CONFIG_GET_INTEGER, int epic_config_get_integer(const char *key, int *va
* errors:
*
* - ``-ENOENT``: Value can not be read
+ *
+ * .. versionadded:: 1.13
*/
API(API_CONFIG_GET_BOOLEAN, int epic_config_get_boolean(const char *key, bool *value));
@@ -1971,6 +1975,8 @@ API(API_CONFIG_GET_BOOLEAN, int epic_config_get_boolean(const char *key, bool *v
* errors:
*
* - ``-ENOENT``: Value can not be read
+ *
+ * .. versionadded:: 1.13
*/
API(API_CONFIG_GET_STRING, int epic_config_get_string(const char *key, char *buf, size_t buf_len));
diff --git a/pycardium/modules/py/simple_menu.py b/pycardium/modules/py/simple_menu.py
index 7a193c68..7bb05009 100644
--- a/pycardium/modules/py/simple_menu.py
+++ b/pycardium/modules/py/simple_menu.py
@@ -124,6 +124,8 @@ class Menu:
"""
Use top right and bottom right buttons to move in the list
instead of bottom left and bottom right buttons.
+
+ .. versionadded:: 1.13
"""
def on_scroll(self, item, index):
--
GitLab