From bc4fce0fae94c311c36b0c4409596ccf84398f06 Mon Sep 17 00:00:00 2001 From: tangkong Date: Tue, 19 Dec 2023 09:42:55 -0800 Subject: [PATCH] REL/DOC: run pre-release notes script, touch up docstrings and docs --- atef/widgets/config/find_replace.py | 6 ++-- docs/source/api.rst | 1 + docs/source/releases.rst | 36 +++++++++++++++++-- .../213-mnt_bug_misc_fixes.rst | 27 -------------- .../214-tst_qt_teardown.rst | 22 ------------ .../219-mnt_enum_check.rst | 22 ------------ .../221-enh_status_out.rst | 23 ------------ .../224-perf_lazy_page.rst | 24 ------------- 8 files changed, 37 insertions(+), 124 deletions(-) delete mode 100644 docs/source/upcoming_release_notes/213-mnt_bug_misc_fixes.rst delete mode 100644 docs/source/upcoming_release_notes/214-tst_qt_teardown.rst delete mode 100644 docs/source/upcoming_release_notes/219-mnt_enum_check.rst delete mode 100644 docs/source/upcoming_release_notes/221-enh_status_out.rst delete mode 100644 docs/source/upcoming_release_notes/224-perf_lazy_page.rst diff --git a/atef/widgets/config/find_replace.py b/atef/widgets/config/find_replace.py index ed610c93..b4b72e4a 100644 --- a/atef/widgets/config/find_replace.py +++ b/atef/widgets/config/find_replace.py @@ -62,9 +62,9 @@ def walk_find_match( Yields a list of 'paths' to the matching key / field. A path is a list of (object, field) tuples that lead from the top level ``item`` to the matching key / field. - - If the object is a dataclass, `field` will be a field in that dataclass - - If the object is a list, `field` will be the index in that list - - If the object is a dict, `field` will be a key in that dictionary + - If the object is a dataclass, ``field`` will be a field in that dataclass + - If the object is a list, ``field`` will be the index in that list + - If the object is a dict, ``field`` will be a key in that dictionary ``match`` should be a Callable taking a single argument and returning a boolean, specifying whether that argument matched a search term or not. This is diff --git a/docs/source/api.rst b/docs/source/api.rst index 2f29b0f8..a71daf7b 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -13,3 +13,4 @@ Dataclasses atef.config atef.procedure atef.tools + atef.walk diff --git a/docs/source/releases.rst b/docs/source/releases.rst index fb000030..4816a3fd 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -2,17 +2,47 @@ Release History ############### +v1.3.0 (2023-12-19) +=================== + +Features +-------- +- Adds results summary page accessible from run-mode in the `atef config` GUI +- Adds icons to run-mode tree view +- Adds page widget cache and lazy loading functionality to the atef config GUI + +Bugfixes +-------- +- :class:`~atef.widgets.config.data_passive.RangeWidget`'s visualizations update a bit more frequently, and also the label text actually updates. Closes #212 +- Adds a menu option to open the welcome tab, since people like it. Closes #201 +- Properly shows an error message box when a file can't be opened. Closes #202 +- Allow tolerances to be `None` in `Equals` comparison. Modifies the line-edit setup to allow null values (`''`, `None`) when casting the line edit value. Closes #128 + +Maintenance +----------- +- Make comparisons against enum signals more robust by trying both the int and string versions if the check fails. +- Refactors tree-walking helpers to a separate submodle (`atef.walk`) +- Replaces use of `functools.partial` with `WeakPartialMethodSlot` in qt slots, cleaning up intermittent test suite failures (and hopefully production crashes) +- Refactors GUI backend to support lazy page loading +- Move tree-building logic to dataclasses +- Consolidate GUI backend classes (`EditTree` / `RunTree` -> `DualTree`, `AtefItem` / `TreeItem` -> `TreeItem`) + +Contributors +------------ +- tangkong + + + v1.2.0 (2023-09-27) =================== Features -------- -- Adds `ScientificDoubleSpinbox` and uses it in MultiModeValueEdit. +- Adds :class:`~atef.widgets.config.utils.ScientificDoubleSpinbox` and uses it in MultiModeValueEdit. Bugfixes -------- -- Waits for signal connection during :class:`ActionRowWidget` initialization to properly - read enum strings from signal. +- Waits for signal connection during :class:`~atef.widgets.config.data_active.ActionRowWidget` initialization to properly read enum strings from signal. Contributors ------------ diff --git a/docs/source/upcoming_release_notes/213-mnt_bug_misc_fixes.rst b/docs/source/upcoming_release_notes/213-mnt_bug_misc_fixes.rst deleted file mode 100644 index 10590d8a..00000000 --- a/docs/source/upcoming_release_notes/213-mnt_bug_misc_fixes.rst +++ /dev/null @@ -1,27 +0,0 @@ -213 mnt_bug_misc_fixes -###################### - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- `RangeWidget`'s visualizations update a bit more frequently, and also the label text actually updates. Closes #212 -- Adds a menu option to open the welcome tab, since people like it. Closes #201 -- Properly shows an error message box when a file can't be opened. Closes #202 -- Removes child `AtefItem` from a ProcedureStep when it's changed from the specific-step-combobox. Closes #195 -- Allow tolerances to be `None` in `Equals` comparison. Modifies the line-edit setup to allow null values (`''`, `None`) when casting the line edit value. Closes #128 - - -Maintenance ------------ -- N/A - -Contributors ------------- -- tangkong diff --git a/docs/source/upcoming_release_notes/214-tst_qt_teardown.rst b/docs/source/upcoming_release_notes/214-tst_qt_teardown.rst deleted file mode 100644 index 14e28719..00000000 --- a/docs/source/upcoming_release_notes/214-tst_qt_teardown.rst +++ /dev/null @@ -1,22 +0,0 @@ -214 tst_qt_teardown -################# - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- Replaces use of functools.partial with `WeakPartialMethodSlot` in qt slots, cleaning up intermittent test suite failures (and hopefully production crashes) - -Contributors ------------- -- tangkong diff --git a/docs/source/upcoming_release_notes/219-mnt_enum_check.rst b/docs/source/upcoming_release_notes/219-mnt_enum_check.rst deleted file mode 100644 index 5d2d8bd8..00000000 --- a/docs/source/upcoming_release_notes/219-mnt_enum_check.rst +++ /dev/null @@ -1,22 +0,0 @@ -219 mnt_enum_check -################## - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- Make comparisons against enum signals more robust by trying both the int and string versions if the check fails. - -Contributors ------------- -- tangkong diff --git a/docs/source/upcoming_release_notes/221-enh_status_out.rst b/docs/source/upcoming_release_notes/221-enh_status_out.rst deleted file mode 100644 index 8843ebed..00000000 --- a/docs/source/upcoming_release_notes/221-enh_status_out.rst +++ /dev/null @@ -1,23 +0,0 @@ -221 enh_status_out -################# - -API Breaks ----------- -- N/A - -Features --------- -- Adds results summary page accessible from run-mode in the `atef config` GUI -- Adds icons to run-mode tree view - -Bugfixes --------- -- N/A - -Maintenance ------------ -- Refactors tree-walking helpers to a separate submodle - -Contributors ------------- -- tangkong diff --git a/docs/source/upcoming_release_notes/224-perf_lazy_page.rst b/docs/source/upcoming_release_notes/224-perf_lazy_page.rst deleted file mode 100644 index 4b1c8eab..00000000 --- a/docs/source/upcoming_release_notes/224-perf_lazy_page.rst +++ /dev/null @@ -1,24 +0,0 @@ -224 perf_lazy_page -################## - -API Breaks ----------- -- N/A - -Features --------- -- Adds page widget cache and lazy loading functionality to the atef config GUI - -Bugfixes --------- -- N/A - -Maintenance ------------ -- Refactors GUI backend to support lazy page loading -- Move tree-building logic to dataclasses -- Consolidate GUI backend classes (EditTree/RunTree -> DualTree, AtefItem/TreeItem -> TreeItem) - -Contributors ------------- -- tangkong