Add defaults for mirror, mirror_x, mirror_y

[MatthewMckee4]

Summary by Sourcery

Enhancements:

• Added default arguments to the mirror, mirror_x, and mirror_y methods in the kfactory.geometry module.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds default values to the mirror, mirror_x, and mirror_y methods in the Geometry class and its subclasses. This change makes it easier to use these methods without having to specify the mirror parameters every time.

Class diagram showing updated mirror methods with default parameters

classDiagram
    class Geometry {
        <<abstract>>
        +mirror(p1: tuple=(1,0), p2: tuple=(0,0))*
        +mirror_x(x: float=0)*
        +mirror_y(y: float=0)*
    }
    class IntegerGeometry {
        +mirror(p1: tuple=(1000,0), p2: tuple=(0,0))
        +mirror_x(x: int=0)
        +mirror_y(y: int=0)
    }
    class FloatGeometry {
        +mirror(p1: tuple=(1,0), p2: tuple=(0,0))
        +mirror_x(x: float=0)
        +mirror_y(y: float=0)
    }
    Geometry <|-- IntegerGeometry
    Geometry <|-- FloatGeometry
    note for Geometry "Abstract base class with mirror methods"
    note for IntegerGeometry "Implementation with integer coordinates"
    note for FloatGeometry "Implementation with float coordinates"

Loading

File-Level Changes

Change	Details	Files
Added default values to the mirror method.	Added default values for p1 and p2 in the mirror method of the Geometry class. Added default values for p1 and p2 in the mirror method of the KCell class. Added default values for p1 and p2 in the mirror method of the DCplxTrans class.	src/kfactory/geometry.py
Added default values to the mirror_x method.	Added a default value for x in the mirror_x method of the Geometry class. Added a default value for x in the mirror_x method of the KCell class. Added a default value for x in the mirror_x method of the DCplxTrans class.	src/kfactory/geometry.py
Added default values to the mirror_y method.	Added a default value for y in the mirror_y method of the Geometry class. Added a default value for y in the mirror_y method of the KCell class. Added a default value for y in the mirror_y method of the DCplxTrans class.	src/kfactory/geometry.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. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.14%. Comparing base (dfbfbe7) to head (e8147d8).
Report is 4 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #588      +/-   ##
==========================================
- Coverage   62.17%   62.14%   -0.04%     
==========================================
  Files          64       64              
  Lines        9431     9431              
  Branches     1735     1735              
==========================================
- Hits         5864     5861       -3     
  Misses       3049     3049              
- Partials      518      521       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.