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.

Sign up for GitHub

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

Jump to bottom

docs(jmespath_util): snippets split, improved, and lint #1419

Merged
merged 29 commits into from
Aug 9, 2022
Merged

docs(jmespath_util): snippets split, improved, and lint #1419

merged 29 commits into from
Aug 9, 2022

Conversation

leandrodamascena
Copy link
Contributor

@leandrodamascena leandrodamascena commented Aug 5, 2022 •
edited
Loading

Issue number: #1374

Summary

Changes

Changes snippet fictitious names to real code snippet filenames for easier discovery and collaboration to improve/correct document snippets.

Some examples have also been refactored so that the codes are complete and there are no lint/pre-commit hooks issues.

User experience

Before
image

After
image

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.

View rendered docs/utilities/jmespath_functions.md

@leandrodamascena leandrodamascena requested a review from a team as a code owner August 5, 2022 07:56
@leandrodamascena leandrodamascena requested review from am29d and removed request for a team August 5, 2022 07:56
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 5, 2022
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Aug 5, 2022
heitorlessa
heitorlessa suggested changes Aug 5, 2022
View reviewed changes
Copy link
Contributor

@heitorlessa heitorlessa left a comment

Choose a reason for hiding this comment

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

That's a great start, thank you so much @leandrodamascena !

Because we're refactoring, more than splitting doc snippets, we should strive for consistency and improved examples - like actual handler functions, maybe custom functions, try/except depending on the use case demonstrated, etc.

examples/jmespath_functions/src/powertools_base64_gzip_jmespath_function.py Outdated Show resolved Hide resolved
examples/jmespath_functions/src/powertools_base64_jmespath_function.py Outdated Show resolved Hide resolved
examples/jmespath_functions/src/powertools_custom_jmespath_function.py Outdated Show resolved Hide resolved
examples/jmespath_functions/src/powertools_json_idempotency_jmespath.py Outdated Show resolved Hide resolved
examples/jmespath_functions/src/powertools_json_jmespath_function.py Outdated Show resolved Hide resolved
@leandrodamascena
Copy link
Contributor Author

That's a great start, thank you so much @leandrodamascena !

Because we're refactoring, more than splitting doc snippets, we should strive for consistency and improved examples - like actual handler functions, maybe custom functions, try/except depending on the use case demonstrated, etc.

Hi Heitor! I understood the point and I will improve examples, typing, exception handling and others. I will work on this PR in the next few days and then I can send the others.

@pull-request-size pull-request-size bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 6, 2022
@leandrodamascena leandrodamascena changed the title docs(jmespath_function): snippets split, improved, fixed and lint docs(jmespath_function): Refactored examples, snippets split, improved, fixed and lint Aug 7, 2022
@heitorlessa heitorlessa changed the title docs(jmespath_function): Refactored examples, snippets split, improved, fixed and lint docs(jmespath_util): Refactored examples, snippets split, improved, fixed and lint Aug 9, 2022
@heitorlessa
Copy link
Contributor

Thank you so much Leandro! I've pushed a few changes to address cosmetic issues and use unused function arguments in some places, like introducing httpbin.org to simulate a dummy payment subscription.

Merging!

@heitorlessa heitorlessa changed the title docs(jmespath_util): Refactored examples, snippets split, improved, fixed and lint docs(jmespath_util): snippets split, improved, and lint Aug 9, 2022
@heitorlessa heitorlessa merged commit 7be425e into aws-powertools:develop Aug 9, 2022
@leandrodamascena leandrodamascena deleted the chore/docs-jmespath branch August 9, 2022 22:44
heitorlessa added a commit to heitorlessa/aws-lambda-powertools-python that referenced this pull request Aug 10, 2022
@heitorlessa
Merge branch 'develop' into chore/refactor-e2e
d1996a6 
* develop:
  chore(ci): update changelog with latest changes
  docs(parser): minor grammar fix (aws-powertools#1427)
  chore(ci): update changelog with latest changes
  docs(apigateway): removes duplicate admonition (aws-powertools#1426)
  chore(ci): update changelog with latest changes
  docs(jmespath_util): snippets split, improved, and lint (aws-powertools#1419)
  chore(ci): reduce payload and only send prod notification
@heitorlessa heitorlessa mentioned this pull request Aug 11, 2022
Closed
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@heitorlessa heitorlessa heitorlessa approved these changes

@am29d am29d Awaiting requested review from am29d am29d was automatically assigned from awslabs/aws-lambda-powertools-python

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@leandrodamascena @heitorlessa