Skip to content
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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Expose write_node #258

wants to merge 1 commit into from

Conversation

jpirnay
Copy link
Contributor

@jpirnay jpirnay commented Oct 17, 2024

Expose the internal _write_node function to the outer world. Picks up feature request #256

Summary by Sourcery

New Features:

  • Expose the internal _write_node function through a new public write_node function.

Copy link

sourcery-ai bot commented Oct 17, 2024

Reviewer's Guide by Sourcery

This pull request exposes the internal _write_node function as a public API by creating a wrapper function called write_node. This change addresses feature request #256.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Expose internal _write_node function as a public API
  • Create a new function called write_node
  • Implement write_node as a wrapper for the internal _write_node function
  • Pass all parameters from write_node to _write_node
svgelements/svgelements.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a 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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment on lines +9661 to +9663
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)
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant