Improve comments, add doctests in symmetric_tree.py #11619
Merged
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 code was improved by enhancing the docstrings for all functions and adding detailed explanations of parameters, return values, and procedures. Doctests were included to validate the correctness of each function, following the
ruff
specifications. TheNode
class now includes an example of usage, demonstrating how to create nodes and access their attributes. Themake_symmetric_tree
andmake_asymmetric_tree
functions were updated with doctests to ensure the trees are constructed correctly. Additional tests were added foris_symmetric_tree
andis_mirror
, showcasing how these functions behave with both symmetric and asymmetric trees.Checklist: