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

Improve docstrings in UDict. #43

Merged
merged 8 commits into from
Jul 6, 2024
Merged

Improve docstrings in UDict. #43

merged 8 commits into from
Jul 6, 2024

Conversation

mbutsk
Copy link
Member

@mbutsk mbutsk commented Jul 5, 2024

Summary by Sourcery

This pull request enhances the UDict class by adding comprehensive docstrings to its methods and properties, improving the overall code documentation and readability.

  • Documentation:
    • Added docstrings to the UDict class and its methods to provide descriptions and improve code documentation.

Copy link
Contributor

sourcery-ai bot commented Jul 5, 2024

Reviewer's Guide by Sourcery

This pull request enhances the documentation of the UDict class by adding detailed docstrings to the class itself and its various methods and properties. These changes aim to improve the readability and maintainability of the code by providing clear descriptions of the functionality and purpose of each component.

File-Level Changes

Files Changes
ufpy/udict.py Added comprehensive docstrings to the UDict class and its methods to improve code documentation and readability.

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.

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

Here's what I looked at during the review
  • 🟡 General issues: 6 issues 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 to tell me if it was helpful.

ufpy/udict.py Outdated Show resolved Hide resolved
ufpy/udict.py Outdated Show resolved Hide resolved
ufpy/udict.py Outdated Show resolved Hide resolved
ufpy/udict.py Outdated Show resolved Hide resolved
ufpy/udict.py Show resolved Hide resolved
ufpy/udict.py Show resolved Hide resolved
@bleudev bleudev dismissed sourcery-ai[bot]’s stale review July 5, 2024 19:37

Requested changes

@bleudev bleudev added documentation Improvements or additions to documentation invalid This doesn't seem right good first pull Good for newcomers labels Jul 5, 2024
@bleudev bleudev added this to the 0.2 milestone Jul 5, 2024
@bleudev bleudev changed the title Udict docstr Improve docstrings to UDict. Jul 5, 2024
@bleudev bleudev changed the title Improve docstrings to UDict. Improve docstrings in UDict. Jul 5, 2024
Copy link
Member

@bleudev bleudev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix that issues

ufpy/udict.py Outdated Show resolved Hide resolved
ufpy/udict.py Outdated Show resolved Hide resolved
@bleudev bleudev self-assigned this Jul 6, 2024
Copy link
Member

@bleudev bleudev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Finally i can say that this pull request is completed. Approved!

@bleudev bleudev merged commit 7d2f444 into main Jul 6, 2024
2 checks passed
@bleudev bleudev deleted the udict-docstr branch July 6, 2024 22:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first pull Good for newcomers invalid This doesn't seem right
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants