Merge pull request #17587 from QuLogic/fix-docs

timhoffm · web-flow · commit c404d1f716e8 · 2020-06-09T03:44:17.000+02:00
Add a docstring to toolkit's BezierPath.__init__.
diff --git a/lib/matplotlib/cbook/deprecation.py b/lib/matplotlib/cbook/deprecation.py
@@ -180,7 +180,7 @@ def finalize(wrapper, new_doc):
                     obj.__doc__ = new_doc
                 except AttributeError:  # Can't set on some extension objects.
                     pass
-                obj.__init__ = wrapper
+                obj.__init__ = functools.wraps(obj.__init__)(wrapper)
                 return obj
 
         elif isinstance(obj, property):
diff --git a/lib/mpl_toolkits/axisartist/axis_artist.py b/lib/mpl_toolkits/axisartist/axis_artist.py
@@ -108,6 +108,14 @@
 class BezierPath(Line2D):
 
     def __init__(self, path, *args, **kwargs):
+        """
+        Parameters
+        ----------
+        path : `~.path.Path`
+            The path to draw.
+        **kwargs
+            All remaining keyword arguments are passed to `.Line2D`.
+        """
         Line2D.__init__(self, [], [], *args, **kwargs)
         self._path = path
         self._invalid = False
