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(idempotency): split snippets, improve wording and lint examples #2492

Merged

Conversation

leandrodamascena
Copy link
Contributor

Issue number: #1372

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

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.

@heitorlessa
Copy link
Contributor

WOOOT WOOOT!!! can't wait to review this. So exciting.

@leandrodamascena leandrodamascena linked an issue Jun 20, 2023 that may be closed by this pull request
@leandrodamascena leandrodamascena changed the title docs(idempotency): snippets split, improved, and lint docs(idempotency): snippets split, improved, and lint Jun 22, 2023
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jun 22, 2023
@boring-cyborg boring-cyborg bot added the internal Maintenance changes label Jun 22, 2023
@pull-request-size pull-request-size bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Jun 22, 2023
@github-actions
Copy link
Contributor

⚠️Large PR detected⚠️

Please consider breaking into smaller PRs to avoid significant review delays. Ignore if this PR has naturally grown to this size after reviews.

2 similar comments
@github-actions
Copy link
Contributor

⚠️Large PR detected⚠️

Please consider breaking into smaller PRs to avoid significant review delays. Ignore if this PR has naturally grown to this size after reviews.

@github-actions
Copy link
Contributor

⚠️Large PR detected⚠️

Please consider breaking into smaller PRs to avoid significant review delays. Ignore if this PR has naturally grown to this size after reviews.

@leandrodamascena leandrodamascena changed the title docs(idempotency): snippets split, improved, and lint docs(idempotency): snippets split, improved, and lint Jun 22, 2023
@leandrodamascena leandrodamascena requested review from rubenfonseca and removed request for heitorlessa June 26, 2023 08:21
Signed-off-by: Ruben Fonseca <fonseka@gmail.com>
@rubenfonseca rubenfonseca requested a review from a team as a code owner June 26, 2023 08:43
@rubenfonseca
Copy link
Contributor

Looking at this now

Copy link
Contributor

@rubenfonseca rubenfonseca left a comment

Choose a reason for hiding this comment

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

AWSome work!

@rubenfonseca rubenfonseca changed the title docs(idempotency): snippets split, improved, and lint docs(idempotency): split snippets, improve wording and lint examples Jun 26, 2023
@rubenfonseca rubenfonseca self-assigned this Jun 26, 2023
@rubenfonseca rubenfonseca merged commit 67c6466 into aws-powertools:develop Jun 26, 2023
rafaelgsr pushed a commit to rafaelgsr/aws-lambda-powertools-python that referenced this pull request Jun 30, 2023
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 internal Maintenance changes size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor Idempotency code snippets
3 participants