From 5bce992c4e363c858cf203b9e783a2ecccfe9e93 Mon Sep 17 00:00:00 2001
From: Prodesire <Prodesire@yeah.net>
Date: Fri, 3 Nov 2017 22:31:03 +0800
Subject: [PATCH] add note to unix_timeout

---
 docs/misc.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/docs/misc.rst b/docs/misc.rst
index 539becb..2e4f5bf 100644
--- a/docs/misc.rst
+++ b/docs/misc.rst
@@ -4,7 +4,7 @@ Miscellanea
 .. function:: pydu.unix_timeout(seconds)
 
   This func decorates any func which may be hang for a while. The param ``seconds``
-  should be integer. ``unix_timeout`` can only be used on ``unix-like`` system.
+  should be integer.
   In `test.py`, you may write like below:
 
   .. code-block:: python
@@ -18,6 +18,8 @@ Miscellanea
 
   And run `test.py`, will see ``TimeoutError``.
 
+  .. note:: ``unix_timeout`` can only be used on ``unix-like`` system.
+
 
 .. function:: pydu.trace(obj)