[ENH]: int / float-tuple like kwarg legend(loc) for rcParams['legend.loc'] #25839

NoyHanan · 2023-05-09T13:53:58Z

PR summary

I Added the ability to use int / float-tuple like kwarg legend(loc) for rcParams['legend.loc'], by creating a new validator for rcParams['legend.loc'].
This new change will help to a consistent and a uniform approach to using the legend.
Addresses both parts of the issue

PR checklist

"closes #0000" is in the body of the PR description to link the related issue
new and changed code is tested
[N/A] Plotting related features are demonstrated in an example
New Features and API Changes are noted with a directive and release note
Documentation complies with general and docstring guidelines

lib/matplotlib/rcsetup.py

chahak13 · 2023-05-11T17:33:09Z

Thank you for your first PR 🎉 Looking forward to more such contributions! :)

NoyHanan · 2023-05-11T19:10:23Z

Thank you for your first PR 🎉 Looking forward to more such contributions! :)

Thank you so much!

NoyHanan · 2023-05-11T19:14:21Z

@chahak13 Do I need to note for the API change / add documentation?

lib/matplotlib/tests/test_rcparams.py

chahak13 · 2023-05-11T20:02:27Z

There should be a note in the what's new section I believe, yes.

NoyHanan · 2023-05-11T20:30:27Z

There should be a note in the what's new section I believe, yes.

Ok, I'll take care of it tomorrow then.

lib/matplotlib/rcsetup.pyi

lib/matplotlib/tests/test_rcparams.py

doc/api/next_api_changes/behavior/22338-NH.rst

tacaswell · 2023-05-12T21:42:42Z

Thank you for your work on this @NoyHanan , I think it is headed the right direction! However I left a couple of comments that need to be addressed.

NoyHanan · 2023-05-13T05:39:42Z

Thank you for your work on this @NoyHanan , I think it is headed the right direction! However I left a couple of comments that need to be addressed.

Hi @tacaswell and @ksunden ,
Thank you for taking the time to review my PR. I appreciate your feedback and will begin working on making the necessary changes.

tacaswell · 2023-05-16T17:32:48Z

There should also be a test of reading an the values from a file.

NoyHanan · 2023-05-16T17:36:05Z

There should also be a test of reading an the values from a file.

On it.

NoyHanan · 2023-05-26T21:00:57Z

Hi @tacaswell!
I know that you many notifications to attend to, so I wanted to kindly inform you that I have made the necessary adjustments to the code based on your feedback (or at least I believe I have :) ).

NoyHanan · 2023-06-04T21:59:30Z

Hi @tacaswell! I know that you many notifications to attend to, so I wanted to kindly inform you that I have made the necessary adjustments to the code based on your feedback (or at least I believe I have :) ).

rcomer

Thank you for your work on this @NoyHanan, and apologies for the delay in reviewing. Could you update the title of this PR to something more descriptive?

lib/matplotlib/rcsetup.py

lib/matplotlib/tests/test_rcparams.py

NoyHanan · 2023-06-21T16:04:16Z

Hi @rcomer,
I appreciate your thorough review of my code. I've made the necessary corrections based on your feedback. I'm looking forward to your thoughts on the updates. Thank you!

lib/matplotlib/rcsetup.py

doc/users/next_whats_new/rcParams[legend.loc]_supports_float_tuple.rst

rcomer

Thanks @NoyHanan, your updates look good to me.

NoyHanan · 2023-06-24T20:57:37Z

Thanks @NoyHanan, your updates look good to me.

@rcomer thanks alot! a few more things:

I'm commiting the changes @QuLogic, does it need to be approved again?
who may merge the pull request to the main repo?

rcomer · 2023-06-24T21:03:23Z

For code changes, we require approvals from two core developers. So yes, please address @QuLogic's comments. Then once he is happy he will likely approve and merge.

QuLogic · 2023-06-28T05:06:31Z

It looks like you'll also need to update the typing stubs now that the validator is private. Also, you may want to squash the changes together.

NoyHanan · 2023-06-28T07:38:41Z

It looks like you'll also need to update the typing stubs now that the validator is private. Also, you may want to squash the changes together.

Sure, no problem.
Can you explain a bit more about how to update?

ksunden · 2023-06-28T08:15:43Z

Just undo the change to the .pyi file

NoyHanan · 2023-06-28T09:50:51Z

Just undo the change to the .pyi file

Thanks!

rcomer · 2023-06-28T10:10:34Z

To squash, you can do an interactive rebase. I strongly recommend saving a backup copy of your branch first if you have not done this (much) before.

NoyHanan · 2023-07-08T14:44:52Z

HI @QuLogic, I'll appriciate your review on the changes I made 🙏

rcomer · 2023-07-08T15:58:32Z

@NoyHanan are you happy to squash the commits, or would you prefer us to take care of that?

NoyHanan · 2023-07-08T16:01:39Z

@NoyHanan are you happy to squash the commits, or would you prefer us to take care of that?

@rcomer I can take care of that, I just thought you guys meant I should squash only the last 3 commits I made for @QuLogic notes.
Should I sqaush them all? and thank you so much for your help and patience.

rcomer · 2023-07-08T18:07:14Z

I think minimal numbers of commits are generally preferred.

…['legend.loc'] matplotlib#22338

NoyHanan · 2023-07-09T09:34:24Z

I think minimal numbers of commits are generally preferred.

Thank you for guiding me. I hope that its fine now.

NoyHanan · 2023-07-15T17:21:14Z

Hi @QuLogic, could you please review the changes I made? 🙏

rcomer · 2023-07-17T08:51:43Z

Congratulations on your first PR merged into Matplotlib @NoyHanan! We hope to hear from you again.

NoyHanan · 2023-07-17T09:57:49Z

Congratulations on your first PR merged into Matplotlib @NoyHanan! We hope to hear from you again.

Thank you so much, I appreciate your support. You'll definitely hear from me again :)

NoyHanan marked this pull request as ready for review May 10, 2023 12:17

NoyHanan force-pushed the bugfix-for-issue-22338 branch from 5f21ef5 to 21a74f4 Compare May 11, 2023 05:12

chahak13 reviewed May 11, 2023

View reviewed changes

lib/matplotlib/rcsetup.py Outdated Show resolved Hide resolved

chahak13 reviewed May 11, 2023

View reviewed changes

lib/matplotlib/tests/test_rcparams.py Outdated Show resolved Hide resolved

tacaswell added this to the v3.8.0 milestone May 12, 2023

tacaswell reviewed May 12, 2023

View reviewed changes

lib/matplotlib/rcsetup.pyi Outdated Show resolved Hide resolved

tacaswell reviewed May 12, 2023

View reviewed changes

lib/matplotlib/tests/test_rcparams.py Outdated Show resolved Hide resolved

tacaswell reviewed May 12, 2023

View reviewed changes

doc/api/next_api_changes/behavior/22338-NH.rst Outdated Show resolved Hide resolved

melissawm added the topic: rcparams label May 15, 2023

rcomer reviewed Jun 18, 2023

View reviewed changes

NoyHanan changed the title ~~Bugfix for issue 22338~~ [ENH]: int / float-tuple like kwarg legend(loc) for rcParams['legend.loc'] Jun 21, 2023

QuLogic reviewed Jun 24, 2023

View reviewed changes

rcomer approved these changes Jun 24, 2023

View reviewed changes

NoyHanan force-pushed the bugfix-for-issue-22338 branch 2 times, most recently from 9bb4013 to df2ac49 Compare June 24, 2023 21:28

NoyHanan force-pushed the bugfix-for-issue-22338 branch from df2ac49 to 3e45dd2 Compare June 28, 2023 09:50

Add ability to use float-tuple like kwarg legend(loc...) for rcParams…

063c22e

…['legend.loc'] matplotlib#22338

NoyHanan force-pushed the bugfix-for-issue-22338 branch from 3e45dd2 to 063c22e Compare July 9, 2023 09:33

QuLogic approved these changes Jul 15, 2023

View reviewed changes

QuLogic merged commit c756cbd into matplotlib:main Jul 15, 2023

Uh oh!

[ENH]: int / float-tuple like kwarg legend(loc) for rcParams['legend.loc'] #25839

[ENH]: int / float-tuple like kwarg legend(loc) for rcParams['legend.loc'] #25839

Uh oh!

Conversation

NoyHanan commented May 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR summary

PR checklist

Uh oh!

Uh oh!

chahak13 commented May 11, 2023

Uh oh!

NoyHanan commented May 11, 2023

Uh oh!

NoyHanan commented May 11, 2023

Uh oh!

Uh oh!

chahak13 commented May 11, 2023

Uh oh!

NoyHanan commented May 11, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tacaswell commented May 12, 2023

Uh oh!

NoyHanan commented May 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tacaswell commented May 16, 2023

Uh oh!

NoyHanan commented May 16, 2023

Uh oh!

NoyHanan commented May 26, 2023

Uh oh!

NoyHanan commented Jun 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rcomer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

NoyHanan commented Jun 21, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rcomer left a comment

Choose a reason for hiding this comment

Uh oh!

NoyHanan commented Jun 24, 2023

Uh oh!

rcomer commented Jun 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

QuLogic commented Jun 28, 2023

Uh oh!

NoyHanan commented Jun 28, 2023

Uh oh!

ksunden commented Jun 28, 2023

Uh oh!

NoyHanan commented Jun 28, 2023

Uh oh!

rcomer commented Jun 28, 2023

Uh oh!

NoyHanan commented Jul 8, 2023

Uh oh!

rcomer commented Jul 8, 2023

Uh oh!

NoyHanan commented Jul 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rcomer commented Jul 8, 2023

NoyHanan commented May 9, 2023 •

edited

Loading

NoyHanan commented May 13, 2023 •

edited

Loading

NoyHanan commented Jun 4, 2023 •

edited

Loading

rcomer commented Jun 24, 2023 •

edited

Loading

NoyHanan commented Jul 8, 2023 •

edited

Loading