Repository navigation
DOC: annotation coords are not floats - #24643
story645 merged 1 commit into
Conversation
Sorry, something went wrong.
|
|
||
| xycoords : str or `.Artist` or `.Transform` or callable or \ | ||
| (float, float), default: 'data' | ||
| 2-element tuple of these, default: 'data' |
There was a problem hiding this comment.
I'm confused since the default is a string and not a 2 element tuple- is this because we don't need to pass in a 2-tuple when the coordinate system is the same?
Sorry, something went wrong.
There was a problem hiding this comment.
Yes, exactly. See the AnnotationBBox demo, where some use a single string and some use two.
Sorry, something went wrong.
There was a problem hiding this comment.
Sorry I didn't catch that this was a line continuation but I'm finding the 'these' so ambiguous that I'm I think extra confused so what about being annoyingly explicit, something like 'scaler or 2 element tuple of str, Artist, callable, or transform : default 'data' "
Sorry, something went wrong.
There was a problem hiding this comment.
How about
xycoords : single or two-tuple of str, `.Artist`, `.Transform` or callable.
Sorry, something went wrong.
…643-on-v3.6.x Backport PR #24643 on branch v3.6.x (DOC: annotation coords are not floats)
PR Summary
There may be a better way to phrase than what I have done here, but I'm pretty sure (float, float) is wrong. The more detailed description for xycoords within the Annotation docstring states that it can be
PR Checklist
Documentation and Tests
Release Notes