docs(metadata): clarify public import path for get_lambda_metadata#8349
Open
leiwilson wants to merge 1 commit into
Open
docs(metadata): clarify public import path for get_lambda_metadata#8349leiwilson wants to merge 1 commit into
leiwilson wants to merge 1 commit into
Conversation
powertools-for-aws-oss-automation
Bot
added
the
size/S
boring-cyborg
Bot
added
the
documentation
|
Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need. |
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Clarifies the public import path for the Metadata utility so it matches the code (
aws_lambda_powertools.utilities.metadata), and warns against the incorrectutilities.lambda_metadatamodule path.Fixes #8056 (Powertools docs clarification; AWS Lambda developer guide example may still need a separate docs-team update).
Changes
docs/utilities/metadata.md: show the correct import snippet and add a warning callout about the wrong pathTest plan
aws_lambda_powertools/utilities/metadata/from aws_lambda_powertools.utilities.metadata import ...Docs-only; no AWS credentials required.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.