-
Notifications
You must be signed in to change notification settings - Fork 0
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
UDict
docs
#7
UDict
docs
#7
Conversation
@sourcery-ai review |
Reviewer's Guide by SourceryThis pull request updates the documentation for the UDict class, introduces the new uSTL package with Stack class documentation, and deprecates the UStack class. It also includes enhancements to the MkDocs configuration and CI workflow. File-Level Changes
Tips
|
There was a problem hiding this 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: 4 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 5 issues found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
@sourcery-ai review |
There was a problem hiding this 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: 3 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 18 issues found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
closes #1
Summary by Sourcery
This pull request updates the documentation for the
UDict
class, introduces the newuSTL
package with initial documentation for theStack
class, and deprecates theUStack
class. It also enhances the MkDocs theme configuration and simplifies the CI workflow for documentation deployment.uSTL
package with initial documentation forStack
class.UDict
documentation to improve clarity and consistency, including better formatting and additional examples.UStack
class in favor ofuSTL.Stack
and updated its documentation accordingly.uSTL
package and its components.