Rename annotate parameter to match upstream

ksunden · timhoffm · ksunden · commit e39e3cfc2f3f · 2020-03-26T12:16:49.000-05:00
Run boilerplate.py

change version rename takes effect

Co-Authored-By: Thomas A Caswell &lt;tcaswell@gmail.com&gt;

Release note of variable change

Rebased onto newer master

Address doc building

Apply suggested language change for release note

Co-Authored-By: Tim Hoffmann &lt;2836374+timhoffm@users.noreply.github.com&gt;
diff --git a/doc/api/next_api_changes/2019-08-12-KS.rst b/doc/api/next_api_changes/2019-08-12-KS.rst
@@ -0,0 +1,8 @@
+Changes in parameter names
+``````````````````````````
+
+The parameter ``s`` to `.Axes.annotate` and  `.pyplot.annotate` is renamed to
+``text``, matching `.Annotation`.
+
+The old parameter name remains supported for `.Axes.annotate`, but
+support for it will be dropped in a future Matplotlib release.
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -753,9 +753,10 @@ def text(self, x, y, s, fontdict=None, **kwargs):
         self._add_text(t)
         return t
 
+    @cbook._rename_parameter("3.2", "s", "text")
     @docstring.dedent_interpd
-    def annotate(self, s, xy, *args, **kwargs):
-        a = mtext.Annotation(s, xy, *args, **kwargs)
+    def annotate(self, text, xy, *args, **kwargs):
+        a = mtext.Annotation(text, xy, *args, **kwargs)
         a.set_transform(mtransforms.IdentityTransform())
         if 'clip_on' in kwargs:
             a.set_clip_path(self.patch)
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -2254,8 +2254,8 @@ def angle_spectrum(
 
 # Autogenerated by boilerplate.py.  Do not edit as changes will be lost.
 @_copy_docstring_and_deprecators(Axes.annotate)
-def annotate(s, xy, *args, **kwargs):
-    return gca().annotate(s, xy, *args, **kwargs)
+def annotate(text, xy, *args, **kwargs):
+    return gca().annotate(text, xy, *args, **kwargs)
 
 
 # Autogenerated by boilerplate.py.  Do not edit as changes will be lost.
