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(event_sources): fix DynamoDB stream event docstring #2468

Merged
merged 1 commit into from
Jun 16, 2023
Merged

docs(event_sources): fix DynamoDB stream event docstring #2468

merged 1 commit into from
Jun 16, 2023

Conversation

abbasyadollahi
Copy link
Contributor

Issue number: #2462

Summary

Changes

Please provide a summary of what's being changed

Updating the dynamodb deserialize function's docstring to reflect the proper return type when deserializing N attributes. Going from str to Decimal.

Also added a missing backtick to another docstring.

User experience

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

It was a str before which was the wrong type.

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.

@abbasyadollahi abbasyadollahi requested a review from a team as a code owner June 15, 2023 18:31
@abbasyadollahi abbasyadollahi requested review from leandrodamascena and removed request for a team June 15, 2023 18:31
@boring-cyborg
Copy link

boring-cyborg bot commented Jun 15, 2023

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

@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jun 15, 2023
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 15, 2023
@rubenfonseca rubenfonseca self-assigned this Jun 15, 2023
@codecov-commenter
Copy link

Codecov Report

Patch coverage has no change and project coverage change: -0.05 ⚠️

Comparison is base (ec207b1) 97.22% compared to head (cf4b05c) 97.17%.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2468      +/-   ##
===========================================
- Coverage    97.22%   97.17%   -0.05%     
===========================================
  Files          157      157              
  Lines         7306     7304       -2     
  Branches       523      509      -14     
===========================================
- Hits          7103     7098       -5     
- Misses         158      159       +1     
- Partials        45       47       +2     
Impacted Files Coverage Δ
...lambda_powertools/utilities/data_classes/common.py 100.00% <ø> (ø)
...s/utilities/data_classes/dynamo_db_stream_event.py 98.13% <ø> (ø)

... and 3 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Contributor

@rubenfonseca rubenfonseca left a comment

Choose a reason for hiding this comment

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

This is amazing! It's so important to get the docs right, so thank you for the time preparing this!

@rubenfonseca rubenfonseca added the event_sources Event Source Data Class utility label Jun 16, 2023
@rubenfonseca rubenfonseca changed the title docs: fix dynamodb stream event deserialize docstring docs(event_sources): fix DynamoDB stream event docstring Jun 16, 2023
@rubenfonseca rubenfonseca merged commit c1ce6fa into aws-powertools:develop Jun 16, 2023
@boring-cyborg
Copy link

boring-cyborg bot commented Jun 16, 2023

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

@abbasyadollahi abbasyadollahi deleted the docs/fix-dynamodb-deserialize-docstring branch June 16, 2023 16:17
rafaelgsr pushed a commit to rafaelgsr/aws-lambda-powertools-python that referenced this pull request Jun 30, 2023
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 event_sources Event Source Data Class utility 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: Type mismatch for N attributes in dynamo_db_stream_event.TypeDeserializer
3 participants