Docstring + import cleanups to legend.py. #16674
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timhoffm
reviewed
Mar 6, 2020
lib/matplotlib/legend.py
Outdated
Comment on lines
12
to
19
| 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. |
Member
There was a problem hiding this comment.
Different sectioning and minor formatting/wording/typo:
Suggested change
| 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. | |
| The `Legend` class is a container of legend handles and legend texts. | |
| The legend handler map specifies how to create legend handles from artists | |
| (lines, patches, etc.) in the axes or figures. Default legend handlers are defined | |
| in the :mod:`~matplotlib.legend_handler` module. While not all artist types are | |
| coverd by the default legend handlers, one can define custom legend handlers | |
| to support arbitrary objects. | |
| See the :doc:`legend guide </tutorials/intermediate/legend_guide>` for more | |
| information. |
Contributor
Author
There was a problem hiding this comment.
done (with small additional edits)
- Reword the module docstring. - Don't import rcParams.
timhoffm
approved these changes
Mar 6, 2020
Member
timhoffm
left a comment
There was a problem hiding this comment.
I‘ll be so bold as to merge with one review. The only non-doc change is the rcParams to mpl.rcParams for which we already have precedence. So let‘s not waste valuable developer time on a second review.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
PR Checklist