Improve the get_node() error message to be more descriptive
#46243
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
Calinou
added
cherrypick:3.x
Calinou
force-pushed
the
improve-get-node-error-message
branch
from
f4f7f5b
to
01dcc63
Compare
RandomShaper
approved these changes
Feb 20, 2021
akien-mga
reviewed
Feb 22, 2021
akien-mga
reviewed
Feb 22, 2021
| ERR_FAIL_COND_V_MSG( | ||
| !node, | ||
| nullptr, | ||
| vformat(R"(Node not found: "%s" (absolute path attempted from "%s").)", p_path, get_path())); |
There was a problem hiding this comment.
Is there much point giving this attempted from "%s" info? An absolute path is an absolute path, it doesn't matter where it originates from.
There was a problem hiding this comment.
I prefer giving as much context as possible from error messages. While absolute paths behave the same from anywhere, I think the context from the absolute path error message should still remain the same as the relative path error message. Otherwise, this could end up being confusing (an error message being less informative depending of the argument you give to a function).
- Mention the origin of the `get_node()` call. - Mention whether the attempted path is absolute or relative. See godotengine#46214.
Calinou
force-pushed
the
improve-get-node-error-message
branch
from
01dcc63
to
e6abdc9
Compare
akien-mga
approved these changes
Feb 22, 2021
|
Thanks! |
|
Cherry-picked for 3.2.4. |
akien-mga
removed
the
cherrypick:3.x
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.
get_node()call.See #46214.
Test project: test_get_node_error.zip
Preview
Before
After