From 19ee9c1b43ce5c9fbe0d1b2c4d1d3b9d6482ceb1 Mon Sep 17 00:00:00 2001
From: Maciej Bocianski <maciej.bocianski@gmail.com>
Date: Thu, 7 Sep 2017 10:19:39 +0200
Subject: [PATCH] Ticker class description update - small interval warning

---
 drivers/Ticker.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/drivers/Ticker.h b/drivers/Ticker.h
index 917eb7c84b..e8bacfa6a7 100644
--- a/drivers/Ticker.h
+++ b/drivers/Ticker.h
@@ -100,6 +100,11 @@ public:
      *
      *  @param func pointer to the function to be called
      *  @param t the time between calls in micro-seconds
+     *
+     *  @note setting @a t to a value shorter that it takes to process the ticker callback
+     *  will cause the system to hang. Ticker callback will be called constantly with no time
+     *  for threads scheduling.
+     *
      */
     void attach_us(Callback<void()> func, us_timestamp_t t) {
         _function = func;