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

Refactor Parser docs code snippets #1371

Closed
Tracked by #1364
heitorlessa opened this issue Jul 25, 2022 · 5 comments · Fixed by #5262
Closed
Tracked by #1364

Refactor Parser docs code snippets #1371

heitorlessa opened this issue Jul 25, 2022 · 5 comments · Fixed by #5262
Assignees
Labels
documentation Improvements or additions to documentation help wanted Could use a second pair of eyes/hands parser Parser (Pydantic) utility

Comments

@heitorlessa
Copy link
Contributor

No description provided.

@hakanson
Copy link

hakanson commented Aug 2, 2022

This was exactly what I was looking for, and worked great. Some comments on making the docs better.

In the Parsing event section, the event_parser decorator calls out:

event_parser decorator will throw a ValidationError if your event cannot be parsed according to the model.

but this has an implication on the Lambda response that could be more explicitly called out. I mainly noticed this because it caused a change in my unit test behavior.

The next section parse function example does solve this, but by using def my_function(): instead of def handler(event: Order, context: LambdaContext): as in the previous example, this was harder (for me) to realize this was the example I really wanted.

Also, the first example had the order: classes, hander def, payload def, invoke hander - and the next example was: classes, payload, function def, (no invoke example). The first example seemed to flow better, and these could be normalized.

@leandrodamascena
Copy link
Contributor

Hey @hakanson! Hope you are well.

Now I'm refactoring all the docs, examples and adding more details in general. I'm planning to send a PR tomorrow or Wednesday..
After submitting the PR, can I tag you to help me validate and improve it?

@hakanson
Copy link

Hey @hakanson! Hope you are well.

Now I'm refactoring all the docs, examples and adding more details in general. I'm planning to send a PR tomorrow or Wednesday..

After submitting the PR, can I tag you to help me validate and improve it?

Yes, I have some commitments coming but will do my best.

Copy link
Contributor

github-actions bot commented Nov 7, 2024

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot added the pending-release Fix or implementation already in dev waiting to be released label Nov 7, 2024
Copy link
Contributor

This is now released under 3.3.0 version!

@github-actions github-actions bot removed the pending-release Fix or implementation already in dev waiting to be released label Nov 14, 2024
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 help wanted Could use a second pair of eyes/hands parser Parser (Pydantic) utility
Projects
Status: Coming soon
Development

Successfully merging a pull request may close this issue.

4 participants