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

chore(docs): update highlighted lines on the Typing examples #4131

Conversation

Emerson-MM-Filho
Copy link
Contributor

@Emerson-MM-Filho Emerson-MM-Filho commented Apr 14, 2024

Enhancing clarity and correctness in the documentation by accurately reflecting the relevant lines in the code snippet.

Issue number:
#4117

Summary

Changes

Updated the highlighted lines in /examples/typing/src/working_with_context_function.py to correctly point to lines 15, 22, and 23, ensuring accuracy for clarity and correctness in the documentation.

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.

@Emerson-MM-Filho Emerson-MM-Filho requested a review from a team as a code owner April 14, 2024 12:37
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Apr 14, 2024
Copy link

boring-cyborg bot commented Apr 14, 2024

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Apr 14, 2024
@rubenfonseca
Copy link
Contributor

Reviewing now

@rubenfonseca rubenfonseca linked an issue Apr 15, 2024 that may be closed by this pull request
1 task
…n.py

Issue: aws-powertools#4117
Enhancing clarity and correctness in the documentation by accurately reflecting the relevant lines in the code snippet.
@rubenfonseca rubenfonseca force-pushed the docs/update-context-function-highlighting branch from 0f992b6 to f35e662 Compare April 15, 2024 09:03
@github-actions github-actions bot added internal Maintenance changes and removed documentation Improvements or additions to documentation labels Apr 15, 2024
Copy link

sonarcloud bot commented Apr 15, 2024

Quality Gate Failed Quality Gate failed

Failed conditions
60.0% Duplication on New Code (required ≤ 50%)

See analysis details on SonarCloud

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.

Super, you got it 100% right! Thank you so much for your first contribution @Emerson-MM-Filho !

@rubenfonseca rubenfonseca changed the title chore(docs): Update highlighted lines in working_with_context_function.py chore(docs): update highlighted lines on the Typing examples Apr 15, 2024
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Apr 15, 2024
@rubenfonseca rubenfonseca merged commit 1d79c72 into aws-powertools:develop Apr 15, 2024
7 of 8 checks passed
Copy link

boring-cyborg bot commented Apr 15, 2024

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!

@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal Maintenance changes size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Incorrect Highlighted Lines in Documentation
2 participants