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(feature_flags): snippets split, improved, and lint #2222

Merged

Conversation

leandrodamascena
Copy link
Contributor

@leandrodamascena leandrodamascena commented May 7, 2023

Issue number: #1373

Summary

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.

@leandrodamascena leandrodamascena requested a review from a team as a code owner May 7, 2023 20:59
@leandrodamascena leandrodamascena requested review from heitorlessa and removed request for a team May 7, 2023 20:59
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label May 7, 2023
@pull-request-size pull-request-size bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label May 7, 2023
@github-actions
Copy link
Contributor

github-actions bot commented May 7, 2023

⚠️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.

1 similar comment
@github-actions
Copy link
Contributor

github-actions bot commented May 7, 2023

⚠️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 linked an issue May 7, 2023 that may be closed by this pull request
@heitorlessa heitorlessa requested review from rubenfonseca and removed request for heitorlessa May 10, 2023 08:18
@rubenfonseca
Copy link
Contributor

Will review this later today

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.

I pushed two small fixes and left two comments to think about. Great great work Leandro!

docs/utilities/feature_flags.md Outdated Show resolved Hide resolved
docs/utilities/feature_flags.md Show resolved Hide resolved
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.

Loved the changes explaining the get vs get_raw. Thank you for this awesome work Leo!

@rubenfonseca rubenfonseca merged commit ef09c8b into aws-powertools:develop May 16, 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 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 Feature Flags code snippets
2 participants