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

Move UStack to ustl #41

Merged
merged 6 commits into from
Jul 1, 2024
Merged

Move UStack to ustl #41

merged 6 commits into from
Jul 1, 2024

Conversation

bleudev
Copy link
Member

@bleudev bleudev commented Jul 1, 2024

closes #40

Summary by Sourcery

This pull request renames UStack to Stack throughout the codebase, including updates to the documentation and test cases. Additionally, it simplifies the setup.py script.

  • Enhancements:
    • Renamed UStack to Stack across the codebase for consistency and clarity.
  • Documentation:
    • Updated documentation to reflect the renaming of UStack to Stack.
  • Tests:
    • Modified test cases to use Stack instead of UStack.
  • Chores:
    • Simplified the setup.py script by removing the __package function and directly using find_packages().

@bleudev bleudev linked an issue Jul 1, 2024 that may be closed by this pull request
Copy link
Contributor

sourcery-ai bot commented Jul 1, 2024

Reviewer's Guide by Sourcery

This pull request renames the UStack class to Stack throughout the codebase, including updates to the documentation and test cases. Additionally, it simplifies the setup.py script by using find_packages().

File-Level Changes

Files Changes
tests/test_ustack.py
ufpy/ustack.py
examples/ustack.md
Renamed UStack to Stack across the codebase, including tests and documentation.
setup.py Simplified the setup.py script by using find_packages() and removing redundant package definitions.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

@bleudev bleudev self-assigned this Jul 1, 2024
@bleudev bleudev added the invalid This doesn't seem right label Jul 1, 2024
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jul 1, 2024
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 @bleudev - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 5 issues found
  • 🟢 Security: all looks good
  • 🟡 Testing: 5 issues found
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 2 issues found

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 to tell me if it was helpful.

ufpy/ustack.py Show resolved Hide resolved
ufpy/ustack.py Show resolved Hide resolved
setup.py Show resolved Hide resolved
setup.py Outdated Show resolved Hide resolved
setup.py Outdated Show resolved Hide resolved
tests/test_ustack.py Show resolved Hide resolved
tests/test_ustack.py Show resolved Hide resolved
examples/ustack.md Outdated Show resolved Hide resolved
examples/ustack.md Outdated Show resolved Hide resolved
setup.py Outdated Show resolved Hide resolved
@bleudev
Copy link
Member Author

bleudev commented Jul 1, 2024

@sourcery-ai review

sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jul 1, 2024
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 @bleudev - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟡 Documentation: 4 issues found

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 to tell me if it was helpful.

examples/ustack.md Outdated Show resolved Hide resolved
examples/ustack.md Outdated Show resolved Hide resolved
examples/ustack.md Outdated Show resolved Hide resolved
examples/ustack.md Outdated Show resolved Hide resolved
ufpy/__init__.py Show resolved Hide resolved
bleudev and others added 4 commits July 1, 2024 23:24
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@bleudev
Copy link
Member Author

bleudev commented Jul 1, 2024

@sourcery-ai review

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 @bleudev - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟡 Security: 1 issue found
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟡 Documentation: 1 issue found

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 to tell me if it was helpful.

ufpy/ustack.py Show resolved Hide resolved
ufpy/ustack.py Show resolved Hide resolved
setup.py Show resolved Hide resolved
examples/ustack.md Show resolved Hide resolved
ufpy/__init__.py Show resolved Hide resolved
@bleudev bleudev merged commit 02a621d into main Jul 1, 2024
2 checks passed
@bleudev bleudev deleted the ustack-to-ustl branch July 1, 2024 20:29
@bleudev bleudev added the breaking change Breaking change label Jul 1, 2024
@bleudev bleudev added this to the 1.0 milestone Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Breaking change invalid This doesn't seem right
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Moving UStack to ustl package
1 participant