[lmi-commits] [lmi] master cf25bd7 1/5: Improve documentation

[Greg Chicares]

branch: master
commit cf25bd750d4b62ef27ce7313f42f99a2b6163ad9
Author: Gregory W. Chicares <address@hidden>
Commit: Gregory W. Chicares <address@hidden>

    Improve documentation
---
 alert_wx.cpp | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/alert_wx.cpp b/alert_wx.cpp
index e4f8f3b..70758b6 100644
--- a/alert_wx.cpp
+++ b/alert_wx.cpp
@@ -53,6 +53,11 @@ bool volatile ensure_setup = set_alert_functions
 ///
 /// Otherwise, simply return. If the message were crucial, then it
 /// wouldn't have been relegated to the statusbar.
+///
+/// Explicitly call Update() to ensure that the message is shown right
+/// away. This is arguably unnecessary, but costs practically nothing;
+/// see:
+///   https://lists.nongnu.org/archive/html/lmi/2018-06/msg00034.html
 
 void status_alert(std::string const& s)
 {