Clarify doc: Node.get_child returns null for invalid index
#86349
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
dalexeev
reviewed
Dec 20, 2023
dalexeev
added
enhancement
documentation
cherrypick:4.1
Both will happen. The debugger will not be stopped, but the error will be logged.
|
|
You're right! Updated. |
|
Please squash commits into one. To do this you need a local git client, GitHub web interface doesn't support it. |
|
Squashed. |
dalexeev
approved these changes
Dec 20, 2023
YuriSizov
reviewed
Dec 22, 2023
akien-mga
changed the title
Node.get_child returns null for invalid index
|
It's still good to have, yeah, even with the new example code. It would need to be reworded slighly to match the new sentence. |
akien-mga
removed
the
cherrypick:4.1
|
Rebased and reworded "error is logged" to "error is generated". Any other changes? |
|
I like it, myself! |
|
Thanks! |
YuriSizov
removed
the
cherrypick:4.2
|
Cherry-picked for 4.2.2. |
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.
This adds a line to
Node.get_child's doc explaining that if no child exists at the specified index,nullwill be returned.I found myself repeatedly writing code that checks for
get_child_count() >= (n + 1)before callingget_child(n). I had a wrong assumption that callingget_childwith an out-of-bounds index would raise an error rather than returning null, as many collections do in other languages/frameworks. I think this would be helpful and relevant to mention in the doc.