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

UDict docs #7

Merged
merged 14 commits into from
Jul 5, 2024
Merged

UDict docs #7

merged 14 commits into from
Jul 5, 2024

Conversation

bleudev
Copy link
Member

@bleudev bleudev commented Jun 30, 2024

closes #1

Summary by Sourcery

This pull request updates the documentation for the UDict class, introduces the new uSTL package with initial documentation for the Stack class, and deprecates the UStack class. It also enhances the MkDocs theme configuration and simplifies the CI workflow for documentation deployment.

  • New Features:
    • Introduced uSTL package with initial documentation for Stack class.
  • Enhancements:
    • Updated UDict documentation to improve clarity and consistency, including better formatting and additional examples.
    • Added a logo to the MkDocs theme configuration.
    • Enhanced MkDocs theme with new features like content code annotation and updated navigation settings.
  • CI:
    • Simplified the GitHub Actions workflow for deploying MkDocs by removing specific branch restrictions.
  • Documentation:
    • Deprecated UStack class in favor of uSTL.Stack and updated its documentation accordingly.
    • Updated the main index documentation to reflect the new structure and features, including the uSTL package and its components.

@bleudev bleudev self-assigned this Jun 30, 2024
@bleudev bleudev added docs Improvements or additions to documentation new feature New feature or request labels Jun 30, 2024
@bleudev bleudev changed the title 0.1 docs UDict docas Jul 5, 2024
@bleudev bleudev changed the title UDict docas UDict docs Jul 5, 2024
@bleudev bleudev marked this pull request as ready for review July 5, 2024 15:04
@bleudev
Copy link
Member Author

bleudev commented Jul 5, 2024

@sourcery-ai review

Copy link

sourcery-ai bot commented Jul 5, 2024

Reviewer's Guide by Sourcery

This 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

Files Changes
docs/useful_classes/udict.md
docs/index.md
docs/useful_classes/ustack.md
docs/uSTL/stack.md
docs/uSTL/index.md
Updated documentation to include new uSTL package, deprecated UStack class, and enhanced UDict documentation with type parameters and examples.
mkdocs.yml
.github/workflows/deploy_mkdocs.yml
Enhanced MkDocs configuration and simplified CI workflow for documentation deployment.

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.

Copy link

@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: 4 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 5 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.

mkdocs.yml Show resolved Hide resolved
mkdocs.yml Show resolved Hide resolved
mkdocs.yml Show resolved Hide resolved
mkdocs.yml Show resolved Hide resolved
docs/useful_classes/udict.md Outdated Show resolved Hide resolved
docs/useful_classes/udict.md Outdated Show resolved Hide resolved
docs/useful_classes/udict.md Outdated Show resolved Hide resolved
docs/uSTL/index.md Outdated Show resolved Hide resolved
docs/useful_classes/ustack.md Outdated Show resolved Hide resolved
@bleudev
Copy link
Member Author

bleudev commented Jul 5, 2024

@sourcery-ai review

Copy link

@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: 3 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 18 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.

mkdocs.yml Show resolved Hide resolved
mkdocs.yml Show resolved Hide resolved
mkdocs.yml Show resolved Hide resolved
docs/useful_classes/udict.md Show resolved Hide resolved
docs/useful_classes/udict.md Show resolved Hide resolved
docs/useful_classes/udict.md Show resolved Hide resolved
docs/useful_classes/udict.md Show resolved Hide resolved
docs/useful_classes/udict.md Show resolved Hide resolved
docs/useful_classes/udict.md Show resolved Hide resolved
docs/useful_classes/udict.md Show resolved Hide resolved
@bleudev bleudev merged commit a997d6d into main Jul 5, 2024
1 check passed
@bleudev bleudev deleted the 0.1-docs branch July 5, 2024 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation new feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: UDict
1 participant