From 237edff366ec0460e8d50edd0800ed36f0d27f3f Mon Sep 17 00:00:00 2001 From: David Stansby Date: Thu, 10 Nov 2022 21:36:16 +0000 Subject: [PATCH] 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 --- docs/api/widgets.md | 2 ++ docs/usage/widget_overview.md | 2 ++ magicgui/widgets/_concrete.py | 2 +- magicgui/widgets/_table.py | 2 +- 4 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/api/widgets.md b/docs/api/widgets.md index 910f45968..3f4145757 100644 --- 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 index 9578de86e..aa31bbf7f 100644 --- 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 index 370439bed..517c04beb 100644 --- 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 index 69b17313c..ad1494edc 100644 --- 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.