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

fix(batch): docstring fix for success_handler() record parameter #1202

Merged
merged 1 commit into from
May 13, 2022

Conversation

peterschutt
Copy link
Contributor

The success_handler() method incorrectly documents the record parameter as a failed record.

Issue number:

Summary

Changes

Please provide a summary of what's being changed

User experience

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

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.

The `success_handler()` method incorrectly documents the `record` parameter as a failed record.
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label May 12, 2022
@boring-cyborg
Copy link

boring-cyborg bot commented May 12, 2022

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.

@michaelbrewer
Copy link
Contributor

nice catch :P

@heitorlessa heitorlessa changed the title success_handler() record parameter docstring fix fix(batch): docstring correction for success_handler() record parameter May 13, 2022
@github-actions github-actions bot added the bug Something isn't working label May 13, 2022
@heitorlessa
Copy link
Contributor

Thank you @peterschutt for taking the time to send this quick fix, much much appreciated!

@heitorlessa heitorlessa changed the title fix(batch): docstring correction for success_handler() record parameter fix(batch): docstring fix for success_handler() record parameter May 13, 2022
@heitorlessa heitorlessa merged commit 666d21c into aws-powertools:develop May 13, 2022
@boring-cyborg
Copy link

boring-cyborg bot commented May 13, 2022

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

heitorlessa added a commit to ran-isenberg/aws-lambda-powertools-python that referenced this pull request May 18, 2022
* develop: (33 commits)
  fix(docs): remove Slack link (aws-powertools#1210)
  docs(roadmap): add new roadmap section (aws-powertools#1204)
  fix(batch): missing space in BatchProcessingError message (aws-powertools#1201)
  fix(batch): docstring fix for success_handler() record parameter (aws-powertools#1202)
  chore(deps): bump email-validator from 1.1.3 to 1.2.1 (aws-powertools#1199)
  docs(layer): upgrade to 1.25.10
  chore: include regression in changelog
  chore: bump to 1.25.10
  feat(parameters): add clear_cache method for providers (aws-powertools#1194)
  chore(ci): changelog pre-generation to fetch tags from origin
  revert(parser): Add missing fields for SESEvent (aws-powertools#1027) (aws-powertools#1190)
  fix(parser): Add missing fields for SESEvent (aws-powertools#1027)
  fix(data-classes): Add missing SES fields and (aws-powertools#1045)
  fix(event_handler): exception_handler to handle ServiceError exceptions (aws-powertools#1160)
  chore(deps-dev): bump flake8-bugbear from 22.1.11 to 22.4.25 (aws-powertools#1156)
  chore(deps-dev): bump mypy from 0.942 to 0.950 (aws-powertools#1162)
  chore(deps-dev): bump flake8-eradicate from 1.2.0 to 1.2.1 (aws-powertools#1158)
  chore(deps): bump github/codeql-action from 1 to 2 (aws-powertools#1154)
  chore(ci): post release on tagged issues too
  fix(event_handler): Allow for event_source support (aws-powertools#1159)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working 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.

3 participants