Change documentation of legend to reflect default upper-right #4357
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
The documentation stated that the default legend position was 0, corresponding to "best". This does not match the behavior of the current code, which uses as default the rcParam value "legend.loc", which at time of writing defaults to "upper-right".
|
I've tripped over this myself. |
WeatherGod
added a commit
that referenced
this pull request
Apr 20, 2015
Change documentation of legend to reflect default upper-right
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The documentation states that the default legend position is 0, which would position it at the "best" place. I've actually believed this and assumed that legend positioning was broken before (if the default is "best", then why bother setting it manually?), but after digging found that this is not the case.
The actual default is controlled at
https://github.com/matplotlib/matplotlib/blob/master/lib/matplotlib/legend.py#L315
which takes the
Nonedefault and pulls thercParam["legend.loc"]which defaults to "upper right". The defaults code actually mentions athttps://github.com/matplotlib/matplotlib/blob/master/lib/matplotlib/rcsetup.py#L663
that it should be changed at some point, but I don't know the reasoning for that so the documentation fix seemed the easiest way.
This literally just changes the docstring to match the current behavior; an alternate patch would be to actually change the default to reflect the documentation.