Fix QgsError.isEmpty() documentation #60488
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
🪟 Windows buildsDownload Windows builds of this PR for testing. 🪟 Windows Qt6 buildsDownload Windows Qt6 builds of this PR for testing. |
|
I currently haven't got a development setup so can't easily do the SIP stuff. I edited directly via GitHub. Sorry! If someone else can and wants to push to this branch, please feel welcome to. I also would not mind a bit if someone simply made a new PR on their own. |
nyalldawson
approved these changes
Feb 7, 2025
|
Superseded by #60503 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The method checks if there is an empty message list. It will actually return
TRUEif there is no error message andFALSEif there is an error.I was surprised when reading the documentation, stating that
isEmpty()returningTRUEwould indicate an error while intuition says "empty error = no error". Checking the code, it is indeed checking for error messages and if there are none, returnsTRUE.So the documentation was falsely inverted.
This PR simply fixes the documentation. I am certain that the behaviour must be kept to avoid lots of breakage everywhere.