Merge pull request #24688 from oscargus/quiverdoc

timhoffm · web-flow · commit cc20d3f7bbb1 · 2022-12-10T22:00:58.000+01:00
Deprecate quiver_doc and barbs_doc class members
diff --git a/doc/api/next_api_changes/deprecations/24688-OG.rst b/doc/api/next_api_changes/deprecations/24688-OG.rst
@@ -0,0 +1,5 @@
+``Quiver.quiver_doc`` and ``Barbs.barbs_doc``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+... are deprecated. These are the doc-string and should not be accessible as
+a named class member.
diff --git a/lib/matplotlib/quiver.py b/lib/matplotlib/quiver.py
@@ -722,7 +722,7 @@ def _h_arrows(self, length):
         # Mask handling is deferred to the caller, _make_verts.
         return X, Y
 
-    quiver_doc = _quiver_doc
+    quiver_doc = _api.deprecated("3.7")(property(lambda self: _quiver_doc))
 
 
 _barbs_doc = r"""
@@ -1179,4 +1179,4 @@ def set_offsets(self, xy):
         super().set_offsets(xy)
         self.stale = True
 
-    barbs_doc = _barbs_doc
+    barbs_doc = _api.deprecated("3.7")(property(lambda self: _barbs_doc))
