From f7878036ad5591b3ed2f8a493f23b99447f3d5be Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Sun, 21 Jul 2019 20:02:32 +0200
Subject: [PATCH] doc: Mention epic_uart_read_chr() is bad

Signed-off-by: Rahix <rahix@rahix.de>
---
 epicardium/epicardium.h | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/epicardium/epicardium.h b/epicardium/epicardium.h
index 485cb2e1..00562f1c 100644
--- a/epicardium/epicardium.h
+++ b/epicardium/epicardium.h
@@ -101,8 +101,11 @@ API(API_UART_WRITE, void epic_uart_write_str(const char *str, intptr_t length));
 
 /**
  * Blocking read a single character from any connected serial device.
- * ``epic_uart_read_chr`` only returns
- * once one byte has been read.
+ * ``epic_uart_read_chr`` only returns once one byte has been read.
+ *
+ * .. todo::
+ *
+ *    This API function is currently in violation of the API rules.
  *
  * :return:  The byte.
  */
-- 
GitLab