Add more detail to the docstring for ShowBalloon()

RobinD42 · Sep 13, 2017 · 05d3fe2 · 05d3fe2
1 parent 9effaa0
commit 05d3fe2
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/etg/taskbar.py b/etg/taskbar.py
@@ -74,6 +74,15 @@ def run():
         doc="""\
             Show a balloon notification (the icon must have been already
             initialized using SetIcon).  Only implemented for Windows.
+
+            The ``title`` and ``text`` parameters are limited to 63 and 255
+            characters respectively, ``msec`` is the timeout, in milliseconds,
+            before the balloon disappears (will be clamped down to the allowed
+            10-30s range by Windows if it's outside it) and ``flags`` can
+            include wxICON_ERROR/INFO/WARNING to show a corresponding icon.
+
+            Returns ``True`` if balloon was shown, ``False`` on error (incorrect
+            parameters or function unsupported by OS).
             """,
         body="""\
             #ifdef __WXMSW__