docs(event-handler): add import path gotcha for dependency_overrides testing#8269
Open
hirenkumar-n-dholariya wants to merge 3 commits into
Conversation
…testing docs(event-handler): add import path gotcha for dependency_overrides testing Signed-off-by: hirenkumar-n-dholariya <hirenkumarnd@gmail.com>
…testing docs(event-handler): add import path gotcha for dependency_overrides testing Signed-off-by: hirenkumar-n-dholariya <hirenkumarnd@gmail.com>
boring-cyborg
Bot
added
the
documentation
powertools-for-aws-oss-automation
Bot
added
the
size/S
|
1 task
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.
Issue number: fixes #8215
Summary
Add a warning callout in the "Testing with dependency overrides" section
explaining that the import path for
dependency_overridesmust exactlymatch between the handler and test file.
Changes
Added
???+ warningadmonition with ✅/❌ tabbed examples showing:User experience
Before: Users encounter a non-obvious bug where
dependency_overridessilently has no effect when import paths don't match
After: Clear warning with examples explaining why import paths must
match exactly, helping users avoid this gotcha
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.