From 05d3fe255a2545bc84adca58ed2cfc838e2b5098 Mon Sep 17 00:00:00 2001 From: Robin Dunn Date: Wed, 13 Sep 2017 15:06:11 -0700 Subject: [PATCH] Add more detail to the docstring for ShowBalloon() --- etg/taskbar.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/etg/taskbar.py b/etg/taskbar.py index 5800fe86..823b2799 100644 --- 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__