Skip to content

Commit 34ed984

Browse files
committed
Fix pyplot.figlegend docstring
Closes #24433
1 parent cd185ab commit 34ed984

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

lib/matplotlib/figure.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -980,7 +980,7 @@ def clf(self, keep_observers=False):
980980
return self.clear(keep_observers=keep_observers)
981981

982982
# Note: in the docstring below, the newlines in the examples after the
983-
# calls to legend() allow replacing it with figlegend() to generate the
983+
# calls to fig.legend() allow replacing it with figlegend() to generate the
984984
# docstring of pyplot.figlegend.
985985
@_docstring.dedent_interpd
986986
def legend(self, *args, **kwargs):
@@ -989,10 +989,10 @@ def legend(self, *args, **kwargs):
989989
990990
Call signatures::
991991
992-
legend()
993-
legend(handles, labels)
994-
legend(handles=handles)
995-
legend(labels)
992+
fig.legend()
993+
fig.legend(handles, labels)
994+
fig.legend(handles=handles)
995+
fig.legend(labels)
996996
997997
The call signatures correspond to the following different ways to use
998998
this method:

lib/matplotlib/pyplot.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -980,7 +980,9 @@ def savefig(*args, **kwargs):
980980
def figlegend(*args, **kwargs):
981981
return gcf().legend(*args, **kwargs)
982982
if Figure.legend.__doc__:
983-
figlegend.__doc__ = Figure.legend.__doc__.replace("legend(", "figlegend(")
983+
figlegend.__doc__ = Figure.legend.__doc__.replace(
984+
"fig.legend(", "figlegend("
985+
)
984986

985987

986988
## Axes ##

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy