Merge pull request matplotlib#22699 from timhoffm/artist-property-decorator

Proof of concept for adding kwdoc content to properties using a decorator

Author: tacaswell

lib/matplotlib/_docstring.py

@@ -3,6 +3,34 @@
 from . import _api
 
 
+def kwarg_doc(text):
+    """
+    Decorator for defining the kwdoc documentation of artist properties.
+
+    This decorator can be applied to artist property setter methods.
+    The given text is stored in a privat attribute ``_kwarg_doc`` on
+    the method.  It is used to overwrite auto-generated documentation
+    in the *kwdoc list* for artists. The kwdoc list is used to document
+    ``**kwargs`` when they are properties of an artist. See e.g. the
+    ``**kwargs`` section in `.Axes.text`.
+
+    The text should contain the supported types as well as the default value
+    if applicable, e.g.:
+
+        @_docstring.kwarg_doc("bool, default: :rc:`text.usetex`")
+        def set_usetex(self, usetex):
+
+    See Also
+    --------
+    matplotlib.artist.kwdoc
+
+    """
+    def decorator(func):
+        func._kwarg_doc = text
+        return func
+    return decorator
+
+
 class Substitution:
     """
     A decorator that performs %-substitution on an object's docstring.

lib/matplotlib/_docstring.pyi

@@ -4,6 +4,9 @@ from typing import Any, Callable, TypeVar, overload
 _T = TypeVar('_T')
 
 
+def kwarg_doc(text: str) -> Callable[[_T], _T]: ...
+
+
 class Substitution:
     @overload
     def __init__(self, *args: str): ...

lib/matplotlib/artist.py

@@ -1482,6 +1482,9 @@ def get_valid_values(self, attr):
             raise AttributeError(f'{self.o} has no function {name}')
         func = getattr(self.o, name)
 
+        if hasattr(func, '_kwarg_doc'):
+            return func._kwarg_doc
+
         docstring = inspect.getdoc(func)
         if docstring is None:
             return 'unknown'

lib/matplotlib/text.py

@@ -1314,6 +1314,7 @@ def set_fontproperties(self, fp):
         self._fontproperties = FontProperties._from_any(fp).copy()
         self.stale = True
 
+    @_docstring.kwarg_doc("bool, default: :rc:`text.usetex`")
     def set_usetex(self, usetex):
         """
         Parameters