search

honey-team / ufpy

Ufpy (Useful Python) - package for Python with some useful features
https://honey-team.github.io/ufpy-website
MIT License
3 stars 3 forks source link

Improve docstrings in `UDict`. #43

Closed mbutsk closed 4 months ago

mbutsk commented 4 months ago

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.

sourcery-ai[bot] commented 4 months ago

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](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.