Fix QgsError.isEmpty() documentation

The method checks if there is an empty message list. It will actually return `TRUE` if there is *no* error message and `FALSE` if there *is* an error.
qgis · Feb 7, 2025 · 7758257 · 7758257
1 parent 702898b
commit 7758257
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/python/PyQt6/core/auto_generated/qgserror.sip.in b/python/PyQt6/core/auto_generated/qgserror.sip.in
@@ -88,9 +88,9 @@ Append new error message.
 
     bool isEmpty() const;
 %Docstring
-Test if any error is set.
+Test if no error is set.
 
-:return: ``True`` if contains error
+:return: ``False`` if contains error
 %End
 
     QString message( QgsErrorMessage::Format format = QgsErrorMessage::Html ) const;

diff --git a/python/core/auto_generated/qgserror.sip.in b/python/core/auto_generated/qgserror.sip.in
@@ -88,9 +88,9 @@ Append new error message.
 
     bool isEmpty() const;
 %Docstring
-Test if any error is set.
+Test if no error is set.
 
-:return: ``True`` if contains error
+:return: ``False`` if contains error
 %End
 
     QString message( QgsErrorMessage::Format format = QgsErrorMessage::Html ) const;

diff --git a/src/core/qgserror.h b/src/core/qgserror.h
@@ -104,8 +104,8 @@ class CORE_EXPORT QgsError
     void append( const QgsErrorMessage &message );
 
     /**
-     * Test if any error is set.
-     *  \returns TRUE if contains error
+     * Test if no error is set.
+     *  \returns FALSE if contains error
      */
     bool isEmpty() const { return mMessageList.isEmpty(); }