Update documentation for new timeout behavior in 3.18 (#42744)

* update documentation for new timeout behavior in 3.18 * fix tests * fix indentation test * Revert "fix indentation test" This reverts commit a2dd639. * fix all tests
qgis · Apr 15, 2021 · efa5a06 · efa5a06
1 parent 31bbdcf
commit efa5a06
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/python/gui/auto_generated/qgsmessagebar.sip.in b/python/gui/auto_generated/qgsmessagebar.sip.in
@@ -214,7 +214,7 @@ Pushes a information ``message`` with default timeout to the message bar.
 
     void pushWarning( const QString &title, const QString &message );
 %Docstring
-Pushes a warning ``message`` with default timeout to the message bar.
+Pushes a warning ``message`` that must be manually dismissed by the user. Before QGIS 3.18 the default timeout was used.
 
 :param title: title string for message
 :param message: The message to be displayed
@@ -224,7 +224,7 @@ Pushes a warning ``message`` with default timeout to the message bar.
 
     void pushCritical( const QString &title, const QString &message );
 %Docstring
-Pushes a critical warning ``message`` with default timeout to the message bar.
+Pushes a critical warning ``message`` that must be manually dismissed by the user. Before QGIS 3.18 the default timeout was used.
 
 :param title: title string for message
 :param message: The message to be displayed

diff --git a/src/gui/qgsmessagebar.h b/src/gui/qgsmessagebar.h
@@ -229,7 +229,7 @@ class GUI_EXPORT QgsMessageBar: public QFrame
     void pushInfo( const QString &title, const QString &message );
 
     /**
-     * Pushes a warning \a message with default timeout to the message bar.
+     * Pushes a warning \a message that must be manually dismissed by the user. Before QGIS 3.18 the default timeout was used.
      *
      * \param title title string for message
      * \param message The message to be displayed
@@ -239,7 +239,7 @@ class GUI_EXPORT QgsMessageBar: public QFrame
     void pushWarning( const QString &title, const QString &message );
 
     /**
-     * Pushes a critical warning \a message with default timeout to the message bar.
+     * Pushes a critical warning \a message that must be manually dismissed by the user. Before QGIS 3.18 the default timeout was used.
      *
      * \param title title string for message
      * \param message The message to be displayed