Merge pull request #1917 from davep/button-docs-widget-redux

Tidy up some Button documentation
Textualize · Mar 2, 2023 · 88a0349 · 88a0349
2 parents 086c7d6 + 0df17fc
commit 88a0349
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/docs/api/button.md b/docs/api/button.md
@@ -1 +1,3 @@
 ::: textual.widgets.Button
+::: textual.widgets._button.ButtonVariant
+::: textual.widgets._button.InvalidButtonVariant
diff --git a/src/textual/widgets/_button.py b/src/textual/widgets/_button.py
@@ -14,11 +14,16 @@
 from ..widgets import Static
 
 ButtonVariant = Literal["default", "primary", "success", "warning", "error"]
+"""The names of the valid button variants.
+
+These are the variants that can be used with a [Button][textual.widgets.Button].
+"""
+
 _VALID_BUTTON_VARIANTS = {"default", "primary", "success", "warning", "error"}
 
 
 class InvalidButtonVariant(Exception):
-    pass
+    """Exception raised if an invalid button variant is used."""
 
 
 class Button(Static, can_focus=True):
@@ -262,6 +267,7 @@ def success(
             name: The name of the button.
             id: The ID of the button in the DOM.
             classes: The CSS classes of the button.
+            disabled: Whether the button is disabled or not.
 
         Returns:
             A Button widget of the 'success' variant.
@@ -293,6 +299,7 @@ def warning(
             name: The name of the button.
             id: The ID of the button in the DOM.
             classes: The CSS classes of the button.
+            disabled: Whether the button is disabled or not.
 
         Returns:
             A Button widget of the 'warning' variant.
@@ -324,6 +331,7 @@ def error(
             name: The name of the button.
             id: The ID of the button in the DOM.
             classes: The CSS classes of the button.
+            disabled: Whether the button is disabled or not.
 
         Returns:
             A Button widget of the 'error' variant.