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

timhoffm · timhoffm · commit ee602b37e5d5 · 2023-02-03T00:54:48.000+01:00
diff --git a/lib/matplotlib/_docstring.py b/lib/matplotlib/_docstring.py
@@ -3,6 +3,31 @@
 from . import _api
 
 
+def kwarg_doc(text):
+    """
+    Decorator for defining the documentation used when artist properties are
+    passed through as keyword arguments.
+
+    See e.g. the `**kwargs` section in `.Axes.text`.
+
+    The given text is stored in a privat variable ``_kwarg_doc`` on the method.
+    It is used for generating the kwdoc list for artists, which we
+    auto-generate through docstring interpolation, e.g. via
+    ``%(Line2D:kwdoc)s``.
+
+    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):
+
+    """
+    def decorator(func):
+        func._kwarg_doc = text
+        return func
+    return decorator
+
+
 class Substitution:
     """
     A decorator that performs %-substitution on an object's docstring.
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -1433,6 +1433,9 @@ def get_valid_values(self, attr):
             raise AttributeError('%s has no function %s' % (self.o, 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'
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -1279,6 +1279,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
