Docs: Incorrect Highlighted Lines in Documentation

[Emerson-MM-Filho]

What were you searching in the docs?

I was searching for information on lambda context typing and how to deal with it in test cases. While reviewing the documentation, I noticed that the highlighted lines in the code snippet were incorrect.

Is this related to an existing documentation section?

https://docs.powertools.aws.dev/lambda/python/latest/utilities/typing/#working-with-context-methods-and-properties

How can we improve?

To improve the experience, ensuring that the highlighted lines in code snippets accurately reflect the relevant lines would enhance clarity and correctness in the documentation.

Got a suggestion in mind?

Update the highlighted lines in the file /examples/typing/src/working_with_context_function.py to correctly reflect lines 15, 22, and 23

powertools-lambda-python/examples/typing/src/working_with_context_function.py

Line 15 in ca0091f

while context.get_remaining_time_in_millis() > limit_execution:

powertools-lambda-python/examples/typing/src/working_with_context_function.py

Lines 22 to 23 in ca0091f

	"request_id": context.aws_request_id,
	"remaining_time": context.get_remaining_time_in_millis(),

instead of lines 16, 25, and 26

powertools-lambda-python/examples/typing/src/working_with_context_function.py

Line 16 in ca0091f

comments: requests.Response = requests.get("https://jsonplaceholder.typicode.com/comments")

powertools-lambda-python/examples/typing/src/working_with_context_function.py

Lines 25 to 26 in ca0091f

	},
	)

This change will ensure accuracy in the highlighted lines for clarity and correctness in the documentation.

Acknowledgment

• I understand the final update might be different from my proposed suggestion, or refused.

[rubenfonseca]

Looking at this now

[rubenfonseca]

AMAZING ATTENTION TO DETAIL, thank you @Emerson-MM-Filho !! Would you like to submit a fix yourself? We would love your contribution on Powertools!

[Emerson-MM-Filho]

AMAZING ATTENTION TO DETAIL, thank you @Emerson-MM-Filho !! Would you like to submit a fix yourself? We would love your contribution on Powertools!

Absolutely! I'm thrilled to hear that my attention to detail is appreciated. I'd be more than happy to submit a fix for Powertools. Let me know how I can get started! 🚀

[rubenfonseca]

@Emerson-MM-Filho super glad to hear :D Follow the "Development environment" and "Your first contribution" guide and send us a PR with the fix!

Specifically, in your case, you should edit the hl_lines commands that appear on the relevant documentation page. (e.g: here)

You can also verify if the fix looks good by generating the documentation locally with make docs-local

We're here to help so if you're stuck reach out here on on our Discord!

[Emerson-MM-Filho]

Thanks so much for the opportunity, @rubenfonseca! I'm grateful for your encouragement and guidance.

Excited to contribute to Powertools! 🚀

[leandrodamascena]

Excited to contribute to Powertools! 🚀

Amamos contribuções da comunidade, @Emerson-MM-Filho! 🚀

Thank you for helping us make Powertools for AWS Lambda even better.

[Emerson-MM-Filho]

Thank you so much for the warm welcome, @leandrodamascena!

I'm thrilled to be a part of the community and excited to help make Powertools for AWS Lambda even better.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.