Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

[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

Merged
timhoffm merged 4 commits intomatplotlib:mainfromoscargus:legendhandlers
Dec 19, 2022

Conversation

oscargus
Copy link
Member

PR Summary

Closes#20639

I'm not 100% sure about the documented arguments inlegend_handlers, so please check those carefully.

PR Checklist

Documentation and Tests

  • Has pytest style unit tests (andpytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).
  • New plotting related features are documented with examples.

Release Notes

  • New features are marked with a.. versionadded:: directive in the docstring and documented indoc/users/next_whats_new/
  • API changes are marked with a.. versionchanged:: directive in the docstring and documented indoc/api/next_api_changes/
  • Release notes conform with instructions innext_whats_new/README.rst ornext_api_changes/README.rst

@oscargusoscargusforce-pushed thelegendhandlers branch 2 times, most recently from0772a65 to8611a1dCompareNovember 23, 2022 18:43
@oscargusoscargus changed the title[Doc] Document legend_handler and legend_handlers[Doc] Document legend_handles and legend_handlersNov 23, 2022
@tacaswelltacaswell added this to thev3.7.0 milestoneNov 23, 2022
@tacaswell
Copy link
Member

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 👎🏻 .

@oscargus
Copy link
MemberAuthor

oscargus commentedNov 24, 2022
edited
Loading

@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 leavelegendHandles pointing tolegend_handles, but only documentlegend_handles?

story645 reacted with thumbs up emoji

@timhoffm
Copy link
Member

Edit: one way to obtain both is to leavelegendHandles pointing tolegend_handles, but only documentlegend_handles?

Yes, that's the reasonable thing to do. I checkedhttps://github.com/search?l=Python&p=5&q=legendHandles&type=Code and it seems thatlegendHandles is widely used.

That way we pomote a clean API but don't break existing code. The maintainance cost for the alias is negligible.

tacaswell reacted with thumbs up emoji

Copy link
Member

@timhoffmtimhoffm left a 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

@tacaswell
Copy link
Member

I took the liberty of accepting the suggestions and normalizing the comment.@oscargus Can you merge this if you are happy with the changes?

oscargusand others added3 commitsDecember 16, 2022 16:38
Co-authored-by: hannah <story645@gmail.com>Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
@tacaswell
Copy link
Member

and rebased + fixed the conflicting changes on main.

@timhoffmtimhoffm merged commit5100378 intomatplotlib:mainDec 19, 2022
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@tacaswelltacaswelltacaswell approved these changes

@story645story645story645 left review comments

@timhoffmtimhoffmtimhoffm approved these changes

Assignees
No one assigned
Projects
None yet
Milestone
v3.7.0
Development

Successfully merging this pull request may close these issues.

document Legend.legendHandles
4 participants
@oscargus@tacaswell@timhoffm@story645

[8]ページ先頭

©2009-2025 Movatter.jp