Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
[Doc] Document legend_handles and legend_handlers#24538
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
0772a65
to8611a1d
CompareUh oh!
There was an error while loading.Please reload this page.
I am 👍🏻 on the docs (left one suggestion), but am 50/50 on the API change. On one hand snake_case 👍🏻 , on the other hand I suspect people have found this (e.g.https://stackoverflow.com/search?tab=votes&q=%5bmatplotlib%5d%20legendHandles) and we should err on not breaking people over aesthetics 👎🏻 . |
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
oscargus commentedNov 24, 2022 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
@tacaswell I'm sure you've seen#20639 (comment) so I ping@timhoffm Personally, I do not have strong opinions on the naming. Edit: one way to obtain both is to leave |
Yes, that's the reasonable thing to do. I checkedhttps://github.com/search?l=Python&p=5&q=legendHandles&type=Code and it seems that That way we pomote a clean API but don't break existing code. The maintainance cost for the alias is negligible. |
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.
Good to go modulo the above wording issues raised by@story645 and@tacaswell
Uh oh!
There was an error while loading.Please reload this page.
I took the liberty of accepting the suggestions and normalizing the comment.@oscargus Can you merge this if you are happy with the changes? |
- deprecate legendHandles
Co-authored-by: hannah <story645@gmail.com>Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
and rebased + fixed the conflicting changes on main. |
Uh oh!
There was an error while loading.Please reload this page.
PR Summary
Closes#20639
I'm not 100% sure about the documented arguments in
legend_handlers
, so please check those carefully.PR Checklist
Documentation and Tests
pytest
passes)Release Notes
.. versionadded::
directive in the docstring and documented indoc/users/next_whats_new/
.. versionchanged::
directive in the docstring and documented indoc/api/next_api_changes/
next_whats_new/README.rst
ornext_api_changes/README.rst