Skip to content

refactor: remove util module #221

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.

Sign up for GitHub

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

Jump to bottom
Merged
cesarcoatl merged 2 commits into from
Oct 28, 2024
Merged

refactor: remove util module #221

cesarcoatl merged 2 commits into from
Oct 28, 2024

Conversation

@cesarcoatl
Copy link
Member

@cesarcoatl cesarcoatl commented Oct 28, 2024 •
edited by sourcery-ai bot
Loading

ref: #199

BREAKING CHANGE: util module has been removed

Summary by Sourcery

Enhancements:

  • Remove the util module from the project.

@cesarcoatl
refactor: remove util module
0f6d1e9 
ref: #199

BREAKING CHANGE: util module has been removed
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Oct 28, 2024 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request removes the util module from the codebase as part of a breaking change. The module has been completely deleted without any replacement or migration of its functionality.

Class diagram for the removal of the util module

classDiagram
    class Util {
        <<removed>>
        +method1()
        +method2()
        +method3()
    }
    note for Util "The entire Util module has been removed as part of a breaking change."
Loading

File-Level Changes

Change Details Files
Complete removal of utility module
  • Deleted the entire utility module without preserving any functionality
  • Implemented as a breaking change
 src/incendium/util.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

sourcery-ai[bot]
sourcery-ai bot reviewed Oct 28, 2024
View reviewed changes
Copy link
Contributor

@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 @cesarcoatl - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Since this is a breaking change removing an entire module, please provide more context in the PR description: What utilities were in this module? Why are they no longer needed? How should users migrate away from these utilities?
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 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.

@cesarcoatl cesarcoatl merged commit 2dfc4d0 into main Oct 28, 2024
@cesarcoatl cesarcoatl deleted the refactor/util/remove branch October 28, 2024 21:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@cesarcoatl