Document help parameter of TraitType.__init__(). (#847)

ipython · Jul 8, 2023 · 194d6da · 194d6da
1 parent 03bafe8
commit 194d6da
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/traitlets/traitlets.py b/traitlets/traitlets.py
@@ -502,6 +502,8 @@ def __init__(
 
         If *read_only* is True, attempts to directly modify a trait attribute raises a TraitError.
 
+        If *help* is a string, it documents the attribute's purpose.
+
         Extra metadata can be associated with the traitlet using the .tag() convenience method
         or by using the traitlet instance's .metadata dictionary.
         """