Skip to content

docs(idempotency): use tab navigation, improves custom serializer example, and additional explanations #3067

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

Merged

Conversation

heitorlessa
Copy link
Contributor

@heitorlessa heitorlessa commented Sep 8, 2023

Issue number: #2951

Summary

Changes

Please provide a summary of what's being changed

  • Changes to tab layout to clean up navigation
  • Added explanation to each approach
  • Documented CustomSerializer on what each option means
  • Changed CustomSerializer option to use an actual Python Class instead of a Dataclass to make it clearer
  • Added code annotations add more explanation to each key part
  • Change from deduced to inferred
  • Make inferred option the first customers read
  • Change all annotated function to have the same name (cognitive overload)

User experience

Please share what the user experience looks like before and after this change

BEFORE

image

AFTER

image image

Checklist

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

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • 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.

@heitorlessa heitorlessa requested a review from a team September 8, 2023 12:47
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Sep 8, 2023
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 8, 2023
@sthulb sthulb requested review from sthulb and removed request for a team September 8, 2023 13:03
@sthulb sthulb merged commit 22a6925 into aws-powertools:develop Sep 8, 2023
@sonarqubecloud
Copy link

sonarqubecloud bot commented Sep 8, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.5% 0.5% Duplication

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/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants