-
-
Notifications
You must be signed in to change notification settings - Fork 8k
Update docs for FancyArrowPatch & Annotation to make it clear that ShrinkA/B parameters are in points and not fractional.
#27947
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
...he Annotate api that use fraction
...nlike the simple arrow uses fraction
@github-actions
github-actions
bot
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join us on gitter for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
It could be argued that the second commit/change to Annotation is not needed since the unit is specified in the default value.
However I personally failed to spot that because Annotation also accepts a simple arrow format where shrink is fractional. When switching from simple to fancy I could not spot the problem. Therefore I still included it in this PR.
I would be happy to re-submit this PR without the change to Annotation if the maintainers feel it isnt needed.
I am pretty sure the change to FancyArrowPatch is needed though.
Thanks @thehappycheese, and congratulations on your first PR merged into Matplotlib! We hope to hear from you again.
FancyArrowPatch & Annotation to make it clear that ShinkA/B parameters are in points and not fractional. (削除ここまで)FancyArrowPatch & Annotation to make it clear that ShrinkA/B parameters are in points and not fractional. (追記ここまで)
PR summary
closes #27941
Updates documentation in two places to make it more clear that
FancyArrowPatchuses point units for theshrinkA&shrinkBparameters.This was particularly unclear when accessing
FancyArrowPatchviaAxes.annotate()because there is an alternate "simple" way to specify an arrow that usesshinkas a fraction rather than as points.Therefore I have also proposed changes to the
Annotationclass 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