Clean up legend loc parameter documentation #25325
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
As we now have different docs for the *loc* parameter to `Figure/Axes.legend`, we can replace the ambiguous 'axes/figure' with the correct type. And also remove 'best' from the `Figure.legend` version. Note, I did not remove 'best' from the numerical table, as that would be annoying to do, so I just annotated it. Fixes #matplotlib#25323
QuLogic
commented
Feb 25, 2023
Comment on lines
-418
to
-420
| The legend location can be specified by setting *loc* with a tuple of | ||
| 2 floats, which is interpreted as the lower-left corner of the legend | ||
| in the normalized axes coordinate. |
There was a problem hiding this comment.
This is already described in the loc parameter docstring, so no need for it here.
Comment on lines
-413
to
-416
| Users can specify any arbitrary location for the legend using the | ||
| *bbox_to_anchor* keyword argument. *bbox_to_anchor* can be a | ||
| `.BboxBase` (or derived there from) or a tuple of 2 or 4 floats. | ||
| See `set_bbox_to_anchor` for more detail. |
There was a problem hiding this comment.
And this is described in much more detail in the bbox_to_anchor parameter docstring, so I didn't see a need to keep it either.
There was a problem hiding this comment.
Agreed, and the user comes to the parameter docstring before this.
rcomer
approved these changes
Feb 28, 2023
Comment on lines
-413
to
-416
| Users can specify any arbitrary location for the legend using the | ||
| *bbox_to_anchor* keyword argument. *bbox_to_anchor* can be a | ||
| `.BboxBase` (or derived there from) or a tuple of 2 or 4 floats. | ||
| See `set_bbox_to_anchor` for more detail. |
There was a problem hiding this comment.
Agreed, and the user comes to the parameter docstring before this.
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Feb 28, 2023
QuLogic
added a commit
that referenced
this pull request
Feb 28, 2023
…325-on-v3.7.x Backport PR #25325 on branch v3.7.x (Clean up legend loc parameter documentation)
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.
PR Summary
As we now have different docs for the loc parameter to
Figure/Axes.legend, we can replace the ambiguous 'axes/figure' with the correct type. And also remove 'best' from theFigure.legendversion.Note, I did not remove 'best' from the numerical table, as that would be annoying to do, so I just annotated it.
Fixes #25323
PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst