Reverse legend #24759

Marvvxi · 2022-12-17T17:21:30Z

PR Summary

I added a parameter for the reverse legend option. See the following images. Taken from #24712.

PR Checklist

Documentation and Tests

[N/A] Has pytest style unit tests (and pytest passes)
Documentation is sphinx and numpydoc compliant (the docs should build without error).
New plotting related features are documented with examples.

Release Notes

[N/A] New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
[N/A]API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
[N/A] Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

github-actions

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

timhoffm

Thanks for the contribution!

Please add a test.

timhoffm · 2022-12-18T16:51:36Z

lib/matplotlib/legend.py

@@ -312,6 +312,7 @@ def __init__(
        numpoints=None,      # number of points in the legend line
        markerscale=None,    # relative size of legend markers vs. original
        markerfirst=True,    # left/right ordering of legend marker and label
+        reverse=False,       # reverse ordering of legend marker and label


Please add a docstring as well. This should go in line 212 (we do a bit of docstring processing that is why the docstring text is in a separate place).

lib/matplotlib/legend.py

timhoffm

Thanks, this is very much in the right direction. Only one extension to the test left.

lib/matplotlib/tests/test_legend.py

lib/matplotlib/legend.py

story645 · 2022-12-20T19:00:57Z

I think you accidentally pulled the main commits into your branch instead of rebasing on main. If you need help cleaning up your branch, let us know and check out https://matplotlib.org/devdocs/devel/development_workflow.html#recovering-from-mess-ups (and let us know if anything in that doc is confusing!)

Marvvxi · 2022-12-20T22:08:31Z

Ups, sorry for the chaos. I tried something, but now my comments in my local repository behind the main comments. If I try to push, I get the message everything up-to-date. Can you help my to clean up my branch, please?

story645 · 2022-12-20T22:22:57Z

can you join incubator? someone can definitely help you there/ it'll probably be easier - ask at https://gitter.im/matplotlib/matplotlib to join

Legend: Refactoring actual labels Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>

lib/matplotlib/legend.py

Legend: docstring correct spelling Co-authored-by: hannah <story645@gmail.com>

story645

Thanks for implementing this! It needs a second approval to merge, but at that point would you like to try rebasing again (w/ help from folks in incubator) or would you like us to squash merge?

Marvvxi · 2022-12-22T17:33:20Z

Thanks for implementing this! It needs a second approval to merge, but at that point would you like to try rebasing again (w/ help from folks in incubator) or would you like us to squash merge?

Thanks for approving and introduction into the development with matplotlib. I would say that the squash merge option is the better way. There are some small not so important commits.

tacaswell · 2022-12-22T18:32:27Z

This should definitely get a whats_new entry!

I think we can sneak this in for 3.7.

story645 · 2022-12-22T18:41:45Z

lib/matplotlib/legend.py

+reverse : bool, default: False
+    If *True*, the legend labels are displayed in reverse order from the input.
+    If *False*, the legend labels are displayed in the same order as the input.
+


Forgot, but based on @tacaswell comment this should also get a version added at the end (skip a line) so like:

..versionadded:: 3.7

https://matplotlib.org/devdocs/devel/coding_guide.html#new-features-and-api-changes

timhoffm · 2022-12-22T23:08:05Z

Thanks @Marvvxi! To keep things simple for you and not go through additional iterations, I've done the final polishing and added a "What's new" entry as well as an additional figure comparison test that the displayed order is indeed reversed. Feel free to check the additions.

@story645 please re-review the additions, and squash-merge when ok. Since my additions are only documetation and a test, I figure we can merge without a third reviewer (I as a the second reviewer have contributed, but only non-code parts).

story645

Take or leave nits - I'll give a couple hours for @Marvvxi to comment & merge tomorrow afternoon EST if I don't hear back.

story645 · 2022-12-23T01:13:24Z

doc/users/next_whats_new/reverse_legend.rst

+Reversed order of legend entries
+--------------------------------
+The order of legend entries can now be reversed by passing ``reverse=True`` to
+`~.Axes.legend`.


Not sure if it's overkill to have a teeny example here, something like

fig, (ax1, ax2) = plt.subplots(ncols=2, figsize=(4,2)) for ax in [ax1, ax2]: ax.axhline(.25, label="25") ax.axhline(.75, label="75") ax1.legend() ax2.legend(reverse=True)

story645 · 2022-12-23T01:14:40Z

doc/users/next_whats_new/reverse_legend.rst

@@ -0,0 +1,4 @@
+Reversed order of legend entries


Suggested change

Reversed order of legend entries

Reverse order of legend entries

story645 · 2022-12-23T01:14:59Z

lib/matplotlib/legend.py

+        if reverse:
+            labels.reverse()
+            handles.reverse()
+
        handles = list(handles)


Suggested change

handles = list(handles)

story645 · 2022-12-25T06:13:45Z

Sorry for the delay in merging, thanks for contributing this new feature, & congrats on your first merged PR @Marvvxi 🥳
We hope to see you again 😄

github-actions bot reviewed Dec 17, 2022

View reviewed changes

story645 added New feature topic: legend labels Dec 18, 2022

timhoffm reviewed Dec 18, 2022

View reviewed changes

tacaswell added this to the v3.8.0 milestone Dec 18, 2022

timhoffm reviewed Dec 19, 2022

View reviewed changes

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

story645 reviewed Dec 19, 2022

View reviewed changes

lib/matplotlib/legend.py Show resolved Hide resolved

github-actions bot added the status: needs rebase label Dec 21, 2022

Marvvxi force-pushed the reverse_legend branch from 80a8cd0 to 1a00ed4 Compare December 22, 2022 11:16

github-actions bot removed the status: needs rebase label Dec 22, 2022

Marvvxi and others added 11 commits December 22, 2022 12:30

Legend: Include reverse parameter and if cond

a94ecc5

Legend: Bugfix comma

cda9334

Legend: Code style

cb52fee

Legend: Linting/flake8

75d9849

Legend: missed whitespace after ','

a67ee8a

Legend: remove reverse from init_legend_box

5633cdf

Legend: Add test for reverse option

8964e8a

Legend: Add docstring

b9f19e1

Update lib/matplotlib/tests/test_legend.py

704184b

Legend: Refactoring actual labels Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>

Legend: include markers test

fad4e44

Legend: Remove x,y list increase readability

2a5ed70

Marvvxi force-pushed the reverse_legend branch from 1a00ed4 to 2a5ed70 Compare December 22, 2022 11:32

story645 reviewed Dec 22, 2022

View reviewed changes

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

Update lib/matplotlib/legend.py

74c5d44

Legend: docstring correct spelling Co-authored-by: hannah <story645@gmail.com>

story645 approved these changes Dec 22, 2022

View reviewed changes

story645 mentioned this pull request Dec 22, 2022

removed casting handles to list in legend #24811

Merged

story645 reviewed Dec 22, 2022

View reviewed changes

ksunden modified the milestones: v3.8.0, v3.7.0 Dec 22, 2022

timhoffm approved these changes Dec 22, 2022

View reviewed changes

timhoffm added 2 commits December 22, 2022 22:01

Add a what's new entry for legend(..., reverse=True)

3723815

Add a test for checking the displayed legend is reversed

fdb5214

timhoffm force-pushed the reverse_legend branch from 4e8fe33 to f6012b4 Compare December 22, 2022 21:27

Added .. versionadded tag to reverse parameter

15911a6

timhoffm force-pushed the reverse_legend branch from f6012b4 to 15911a6 Compare December 22, 2022 22:06

story645 approved these changes Dec 23, 2022

View reviewed changes

rcomer linked an issue Dec 23, 2022 that may be closed by this pull request

[ENH]: Reverse legend #24712

Closed

story645 merged commit edfd3b4 into matplotlib:main Dec 25, 2022

pseyfert mentioned this pull request Dec 27, 2022

[ENH]: Reverse legend #24712

Closed

story645 mentioned this pull request Dec 27, 2022

space in version added for reverse in legend #24826

Merged

tacaswell mentioned this pull request Mar 27, 2023

hist reverses legend order if histtype is not bar #8461

Open

story645 mentioned this pull request May 23, 2023

Reverse stackplot legend to match data display #25956

Merged

3 tasks

kafitzgerald mentioned this pull request Oct 16, 2024

Upstream CI failures NCAR/geocat-examples#620

Closed

	Reversed order of legend entries
	Reverse order of legend entries

Uh oh!

Reverse legend #24759

Reverse legend #24759

Uh oh!

Conversation

Marvvxi commented Dec 17, 2022

PR Summary

PR Checklist

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

timhoffm left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

timhoffm Dec 18, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

timhoffm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

story645 commented Dec 20, 2022

Uh oh!

Marvvxi commented Dec 20, 2022

Uh oh!

story645 commented Dec 20, 2022

Uh oh!

Uh oh!

story645 left a comment

Choose a reason for hiding this comment

Uh oh!

Marvvxi commented Dec 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tacaswell commented Dec 22, 2022

Uh oh!

story645 Dec 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

timhoffm commented Dec 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

story645 left a comment

Choose a reason for hiding this comment

Uh oh!

story645 Dec 23, 2022

Choose a reason for hiding this comment

Uh oh!

story645 Dec 23, 2022

Choose a reason for hiding this comment

Uh oh!

story645 Dec 23, 2022

Choose a reason for hiding this comment

Uh oh!

story645 commented Dec 25, 2022

Uh oh!

Uh oh!

timhoffm left a comment •

edited

Loading

Marvvxi commented Dec 22, 2022 •

edited

Loading

story645 Dec 22, 2022 •

edited

Loading

timhoffm commented Dec 22, 2022 •

edited

Loading