Fix Annotation arrow not updating after setting patchA#31438
Draft
dikshajangra12918-oss wants to merge 5 commits intomatplotlib:mainfrom
Draft
Fix Annotation arrow not updating after setting patchA#31438dikshajangra12918-oss wants to merge 5 commits intomatplotlib:mainfrom
dikshajangra12918-oss wants to merge 5 commits intomatplotlib:mainfrom
Conversation
Setting patchA on Annotation.arrow_patch has no visible effect because the arrow position is not recomputed. This change ensures that the annotation is marked as stale when patchA changes, triggering proper recomputation during rendering.
QuLogic
requested changes
Apr 3, 2026
Member
QuLogic
left a comment
There was a problem hiding this comment.
I don't really understand how this is a fix. update_positions is called from draw, which means the artist is already stale and you're triggering a second draw now by marking it stale again.
Also, is this fixing some existing bug? Please add a test to show what you are actually fixing.
Add logic to prevent overriding user-set patchA in update_positions. Fixes issues matplotlib#28316.
Add test to verify that manually set patchA on annotation arrow is preserved after draw.
Author
|
Thankyou for the review! |
1. Add 2 blank lines before function definition 2. Split long comment line to stay within 80 chars
Only update patchA internally if user has not manually set it.
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
2 participants
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.
PR summary
Why is this change necessary?
Setting
patchAonAnnotation.arrow_patchcurrently has no visible effect because the arrow position is not recomputed after updatingpatchA.What problem does it solve?
This change ensures that when
patchAis modified, the annotation is marked as stale. This triggers a recomputation of the arrow position during rendering, fixing the issue where the arrow does not align or clip correctly with the associated text.What is the reasoning for this implementation?
The arrow position is initially computed correctly, but subsequent updates to
patchAare not reflected visually. By marking the annotation as stale whenpatchAchanges, we ensure that the rendering pipeline updates the arrow position accordingly.AI Disclosure
AI assistance was used in a manner for understanding parts of the codebase and validating the approach. The implementation and reasoning were completed and verified independently.