REL/DOC: run pre-release notes script, touch up docstrings and docs

pcdshub · Dec 19, 2023 · bc4fce0 · bc4fce0
1 parent 27163da
commit bc4fce0
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 124 deletions.
diff --git 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
@@ -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
@@ -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
diff --git a/docs/source/upcoming_release_notes/214-tst_qt_teardown.rst b/docs/source/upcoming_release_notes/214-tst_qt_teardown.rst
diff --git a/docs/source/upcoming_release_notes/219-mnt_enum_check.rst b/docs/source/upcoming_release_notes/219-mnt_enum_check.rst
diff --git a/docs/source/upcoming_release_notes/221-enh_status_out.rst b/docs/source/upcoming_release_notes/221-enh_status_out.rst
diff --git a/docs/source/upcoming_release_notes/224-perf_lazy_page.rst b/docs/source/upcoming_release_notes/224-perf_lazy_page.rst