-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Document Artist.get_cursor_data #12427
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
Similar to monkey-patching The actual changes here look fine. |
@ImportanceOfBeingErnest Maybe a bit beyond this PR, but for monkey-patching we must also specify what I'm not clear about this myself. Is this just called with Do we know if there are really people using this API? |
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.
feel free to dismiss once comment handled (even if just to say "let's keep it as it is")
lib/matplotlib/artist.py
Outdated
|
||
.. note:: | ||
This is part of the internal API. As an end-user of Matplotlib | ||
you will most likely not call this method yourself. |
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.
I don't particularly like the wording here, there are in fact a lot of other "public" parts of the Matplotlib API that are "intended as internal/private" (even more than this API)... I guess I'd prefer just something like "intended to be overridden by artist subclasses/monkeypatched" two paragraphs below.
c7e4006
to
2c92f1d
Compare
lib/matplotlib/artist.py
Outdated
likely not call this method yourself. | ||
|
||
The default implementation converts ints and floats and arrays of ints | ||
and floats into a comma-separated string. |
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.
comma-separated string, enclosed in square brackets
2c92f1d
to
af3373a
Compare
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.
@timhoffm can self-merge on CI pass.
Anyone knows something about the |
From now on, everyone running the below code, is using this 😁
Implicitely, it needs to be a
|
PR Summary
Closes #12279.
We might additionally consider making
get_cursor_data
andformat_cursor_data
private. I don't see a use-case for the end-user.