Update docs for FancyArrowPatch
& Annotation
to make it clear that ShrinkA/B parameters are in points and not fractional.
#27947
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
closes #27941
Updates documentation in two places to make it more clear that
FancyArrowPatch
uses point units for theshrinkA
&shrinkB
parameters.This was particularly unclear when accessing
FancyArrowPatch
viaAxes.annotate()
because there is an alternate "simple" way to specify an arrow that usesshink
as a fraction rather than as points.Therefore I have also proposed changes to the
Annotation
class in the text module.Also please summarize the changes in the title, for example "Raise ValueError on
non-numeric input to set_xlim" and avoid non-descriptive titles such as "Addresses
issue #8576".
PR checklist