Skip to content

docs(parser): add section on how to test parser using decorator #2755

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
merged 5 commits into from
Jul 11, 2024

Conversation

am29d
Copy link
Contributor

@am29d am29d commented Jul 10, 2024

Summary

This PR adds a section about testing parser when using decorator.

Changes

Please provide a summary of what's being changed

Added the testing section to parser, with examples for schema and safeParse option. Using middy with parser does not have any implications on tests compared to decorator.

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

Issue number: closes #2737


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.

@am29d am29d requested a review from a team July 10, 2024 09:58
@am29d am29d requested a review from a team as a code owner July 10, 2024 09:58
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jul 10, 2024
@pull-request-size pull-request-size bot added the size/L PRs between 100-499 LOC label Jul 10, 2024
dreamorosi
dreamorosi previously approved these changes Jul 10, 2024
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

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

Left a few comments, good addition to the docs!

@am29d am29d requested a review from dreamorosi July 10, 2024 14:41
@dreamorosi
Copy link
Contributor

If you're okay with this, we'll merge this tomorrow right after the release. So we put all the Parser changes together in the next release.

@am29d am29d added on-hold This item is on-hold and will be revisited in the future do-not-merge This item should not be merged and removed on-hold This item is on-hold and will be revisited in the future labels Jul 10, 2024
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

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

Thank you for this improvement!

@dreamorosi dreamorosi removed the do-not-merge This item should not be merged label Jul 11, 2024
Copy link

@dreamorosi dreamorosi merged commit d6e92cc into main Jul 11, 2024
10 checks passed
@dreamorosi dreamorosi deleted the parser/docs-test-section branch July 11, 2024 10:33
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 PRs between 100-499 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: add testing section to parser documentation
2 participants