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

docs(parser): improve documentation with Pydantic best practices #5925

Merged
merged 2 commits into from
Jan 27, 2025

Conversation

AlphaWong
Copy link
Contributor

@AlphaWong AlphaWong commented Jan 27, 2025

Issue number: #5926

Summary

root_validator (deprecated as of version 3.0.0) but the doc is outdated, the root_validator doc still appears on 3.2.0.

Changes

If customers are migrating their library from version 2, refer to the latest documentation for updated methods compatible with root_validator

User experience

N/A

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change? nope

RFC issue number:

Checklist:

  • [ x ] Migration process documented
  • [ x ] Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@AlphaWong AlphaWong requested a review from a team January 27, 2025 15:12
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jan 27, 2025
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jan 27, 2025
Copy link

boring-cyborg bot commented Jan 27, 2025

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

@leandrodamascena leandrodamascena changed the title doc: improve the doc for the customer from v2 library. docs(parser): improve documentation with Pydantic best practices Jan 27, 2025
@leandrodamascena leandrodamascena linked an issue Jan 27, 2025 that may be closed by this pull request
1 task
Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

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

Hey @AlphaWong! Thanks a lot for suggesting this change, I think this make lot of sense!

I just left a small comment to improve the message. Please let me know when you change this and then we can merge this PR.

Co-authored-by: Leandro Damascena <lcdama@amazon.pt>
Signed-off-by: Alpha <AlphaWong@users.noreply.github.com>
Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

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

Approved! Thanks @AlphaWong!

@leandrodamascena leandrodamascena merged commit 6baeec4 into aws-powertools:develop Jan 27, 2025
6 checks passed
Copy link

boring-cyborg bot commented Jan 27, 2025

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!

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 size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: improve documentation with Pydantic best practices
2 participants