Fix docstring of Axes.cla()

timhoffm · timhoffm · commit d978b3bcdd88 · 2020-10-10T16:04:21.000+02:00
The docstring was written for pyplot.cla() but "current" is incorrect
for the Axes method. Also, Axes.cla() and Axes.clear() should have the
same docstring as they are synonyms.

To support a different docstring in pyplot, I had to explicitly define
pyplot.cla() and remove it from boilerplate.py generation. Given that
the function is trivial, this is an ok tradeoff for a better docstring
on the Axes.
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -1088,7 +1088,7 @@ def sharey(self, other):
         self.yaxis._scale = other.yaxis._scale
 
     def cla(self):
-        """Clear the current axes."""
+        """Clear the axes."""
         # Note: this is called by Axes.__init__()
 
         # stash the current visibility state
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -1064,6 +1064,12 @@ def sca(ax):
     ax.figure.sca(ax)
 
 
+def cla():
+    """Clear the current axes."""
+    # Not generated via boilerplate.py to allow a different docstring.
+    return gca().cla()
+
+
 ## More ways of creating axes ##
 
 @docstring.dedent_interpd
@@ -2626,12 +2632,6 @@ def broken_barh(xranges, yrange, *, data=None, **kwargs):
         **({"data": data} if data is not None else {}), **kwargs)
 
 
-# Autogenerated by boilerplate.py.  Do not edit as changes will be lost.
-@_copy_docstring_and_deprecators(Axes.cla)
-def cla():
-    return gca().cla()
-
-
 # Autogenerated by boilerplate.py.  Do not edit as changes will be lost.
 @_copy_docstring_and_deprecators(Axes.clabel)
 def clabel(CS, levels=None, **kwargs):
diff --git a/tools/boilerplate.py b/tools/boilerplate.py
@@ -201,7 +201,6 @@ def boilerplate_gen():
         'barh',
         'boxplot',
         'broken_barh',
-        'cla',
         'clabel',
         'cohere',
         'contour',
