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(middleware-factory): Fix and improve typing #3569

Conversation

kamilturek
Copy link
Contributor

@kamilturek kamilturek commented Dec 28, 2023

Issue number: #3556

Summary

Changes

This PR fixes middleware factory examples by changing invalid Callable return types to dict, and adds type annotations for other middleware arguments.

User experience

N/A

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.

@kamilturek kamilturek requested a review from a team as a code owner December 28, 2023 23:48
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Dec 28, 2023
Copy link

boring-cyborg bot commented Dec 28, 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/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Dec 28, 2023
@kamilturek kamilturek changed the title docs(middleware factory typing docs(middleware-factory): Fix and improve typing Dec 28, 2023
@leandrodamascena leandrodamascena linked an issue Dec 29, 2023 that may be closed by this pull request
1 task
Copy link
Contributor

No related issues found. Please ensure there is an open issue related to this change to avoid significant delays or closure.

@github-actions github-actions bot added do-not-merge need-issue PRs that are missing related issues labels Dec 29, 2023
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 @kamilturek, you were very quick to send this PR! I left some comments before merging 🚀

docs/utilities/middleware_factory.md Outdated Show resolved Hide resolved
docs/utilities/middleware_factory.md Outdated Show resolved Hide resolved
docs/utilities/middleware_factory.md Outdated Show resolved Hide resolved
@leandrodamascena leandrodamascena removed do-not-merge need-issue PRs that are missing related issues labels Dec 29, 2023
Copy link

sonarcloud bot commented Dec 29, 2023

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@kamilturek
Copy link
Contributor Author

Hey @leandrodamascena, thanks for reviewing the PR! I agree with your comments. I've just pushed an update.

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 a lot @kamilturek!

@leandrodamascena leandrodamascena merged commit aed8ddd into aws-powertools:develop Dec 29, 2023
4 checks passed
Copy link

boring-cyborg bot commented Dec 29, 2023

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

@kamilturek kamilturek deleted the docs-middleware-factory-typing branch December 29, 2023 14:22
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/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Invalid return type in middleware example
2 participants