Fix pyplot.figlegend docstring #24434
Merged
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.
Closes #24433
PR Summary
The method name for
Figure.legendinpyplotisfiglegenddue to a name collision.As such, a
.replacecall is used to translate the docstring from the one written forFigure.legendto make sense for users interacting withplt.figlegend.This behavior was originally introduced in #11975, using
legend(alone (with no dotted name).The docstring was updated in #18106, with additional examples that used
fig.legend(in additional examples.These new examples were caught by the replace and became
fig.figlegend(.This PR makes all calls
fig.legendand simply removes the dot for the replace call.This leads to some slightly incongrous examples which are using the object based api to call
ax.plotbut following that withfiglegendfrompyplot. (not wrong per se, but mixing APIs)This was chosen as a compromise to allow the docstring to have one cannonical form, while still using the method name where
helpis called.PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
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