Clarify that replace_by keeps child nodes in tree #55777
Merged
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
YuriSizov
added
documentation
topic:core
cherrypick:3.x
mhilbrunner
approved these changes
Dec 15, 2021
mhilbrunner
approved these changes
Dec 15, 2021
|
Thank you! |
|
Cherry-picked for 3.5. |
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.
Closes #28746
Related: #55710
The name of this function seems to cause confusion. It can sound as if it would be replacing a whole subtree, or as if it replaces a single node with another single node. In truth it's neither: A single node is removed from the tree, while a subtree is added to the tree. The children of the replaced node are reparented to the new node, resulting in a merged list of child nodes.
Mentioning this behavior in the documentation could help prevent misuse / unexpected behavior.