docs: Add Table and Quantity to API docs (#493)

* Add Table to API docs * add to widget_overview, add quantity too Co-authored-by: Talley Lambert <talley.lambert@gmail.com>
pyapp-kit · Nov 10, 2022 · 237edff · 237edff
1 parent d2fc287
commit 237edff
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git a/docs/api/widgets.md b/docs/api/widgets.md
@@ -32,6 +32,8 @@ Value Widgets
    DateTimeEdit
    DateEdit
    TimeEdit
+   Table
+   QuantityEdit
    EmptyWidget
 
 

diff --git a/docs/usage/widget_overview.md b/docs/usage/widget_overview.md
@@ -131,6 +131,8 @@ following `ValueWidgets` track some `value`:
    DateTimeEdit
    DateEdit
    TimeEdit
+   Table
+   QuantityEdit
 ```
 
 ```{list-table}

diff --git a/magicgui/widgets/_concrete.py b/magicgui/widgets/_concrete.py
@@ -1045,4 +1045,4 @@ def label_width(self, width):
 
 @backend_widget
 class QuantityEdit(ValueWidget):
-    """A combined LineEdit and ComboBox to edit a pint.Quantity."""
+    """A combined `LineEdit` and `ComboBox` to edit a `pint.Quantity`."""
diff --git a/magicgui/widgets/_table.py b/magicgui/widgets/_table.py
@@ -128,7 +128,7 @@ def __repr__(self) -> str:
 
 
 class Table(ValueWidget, _ReadOnlyMixin, MutableMapping[TblKey, list]):
-    """A table widget representing columnar or 2D data with headers.
+    """A widget to represent columnar or 2D data with headers.
 
     Tables behave like plain `dicts`, where the keys are column headers and the
     (list-like) values are column data.