define trait.__doc__ = trait.help (#816)

improves inspection via tools like sphinx autodoc
ipython · Dec 16, 2022 · 74928f6 · 74928f6
1 parent 1dbf7e9
commit 74928f6
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/traitlets/traitlets.py b/traitlets/traitlets.py
@@ -558,6 +558,9 @@ def __init__(
         if read_only is not None:
             self.read_only = read_only
         self.help = help if help is not None else ""
+        if self.help:
+            # define __doc__ so that inspectors like autodoc find traits
+            self.__doc__ = self.help
 
         if len(kwargs) > 0:
             stacklevel = 1