Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Docstring + import cleanups to legend.py.#16674
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
lib/matplotlib/legend.py Outdated
| The Legend class is a container of legend handles and legend texts. The legend | ||
| handler map specifies how to create legend handle from artists (lines, patches, | ||
| etc.) in the axes or figures; default legend handlers are defined in the | ||
| :mod:`~matplotlib.legend_handler` module. | ||
| The default legend handlers do not cover all artist types, but custom legend | ||
| handlers can be defined to support arbitrary objects. See the :doc:`legend | ||
| guide </tutorials/intermediate/legend_guide>` for more information. |
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.
Different sectioning and minor formatting/wording/typo:
| TheLegendclassisacontaineroflegendhandlesandlegendtexts.Thelegend | |
| handlermapspecifieshowtocreatelegendhandlefromartists (lines,patches, | |
| etc.)intheaxesorfigures;defaultlegendhandlersaredefinedinthe | |
| :mod:`~matplotlib.legend_handler`module. | |
| Thedefaultlegendhandlersdonotcoverallartisttypes,butcustomlegend | |
| handlerscanbedefinedtosupportarbitraryobjects.Seethe :doc:`legend | |
| guide</tutorials/intermediate/legend_guide>`formoreinformation. | |
| The`Legend`classisacontaineroflegendhandlesandlegendtexts. | |
| Thelegendhandlermapspecifieshowtocreatelegendhandlesfromartists | |
| (lines,patches,etc.)intheaxesorfigures.Defaultlegendhandlersaredefined | |
| inthe :mod:`~matplotlib.legend_handler`module.Whilenotallartisttypesare | |
| coverdbythedefaultlegendhandlers,onecandefinecustomlegendhandlers | |
| tosupportarbitraryobjects. | |
| Seethe :doc:`legend guide </tutorials/intermediate/legend_guide>`formore | |
| information. |
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.
done (with small additional edits)
- Reword the module docstring.- Don't import rcParams.
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‘ll be so bold as to merge with one review. The only non-doc change is thercParams tompl.rcParams for which we already have precedence. So let‘s not waste valuable developer time on a second review.
PR Summary
PR Checklist