-
-
Notifications
You must be signed in to change notification settings - Fork 29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Expose write_node #258
base: master
Are you sure you want to change the base?
Expose write_node #258
Conversation
Reviewer's Guide by SourceryThis pull request exposes the internal No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @jpirnay - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding documentation for the new
write_node
function to explain its purpose, parameters, and expected usage. - The
write_node
function doesn't return a value. Is this intentional? If so, consider returning the result of_write_node
or documenting that it returns None.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
def write_node(node, xml_tree=None, viewport_transform=None): | ||
# Wrapper function to expose the internal underscore function | ||
_write_node(node, xml_tree, viewport_transform) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue (bug_risk): The write_node function doesn't return the result of _write_node
This wrapper function calls _write_node but doesn't return its result. This could lead to unexpected behavior if the caller expects a return value. Consider either returning the result of _write_node or reevaluating the necessity of this wrapper function if it's not adding any additional functionality.
Expose the internal _write_node function to the outer world. Picks up feature request #256
Summary by Sourcery
New Features: