From 5933d5d9a0fac7379980a25ed49073a04a6e8398 Mon Sep 17 00:00:00 2001 From: tangkong Date: Tue, 20 Aug 2024 13:23:16 -0700 Subject: [PATCH] REL: release notes v4.0.0 --- docs/source/release_notes.rst | 47 +++++++++++++++++++ .../604-perf_resize_text.rst | 22 --------- .../606-enh_wait_status.rst | 28 ----------- .../607-tst_fix_ci_saga.rst | 22 --------- .../611-enh_positioner_resizing.rst | 25 ---------- .../615-maint_fix_ci.rst | 22 --------- .../616-fix_enum_handling.rst | 23 --------- .../618-bld_jinja_bump.rst | 22 --------- 8 files changed, 47 insertions(+), 164 deletions(-) delete mode 100644 docs/source/upcoming_release_notes/604-perf_resize_text.rst delete mode 100644 docs/source/upcoming_release_notes/606-enh_wait_status.rst delete mode 100644 docs/source/upcoming_release_notes/607-tst_fix_ci_saga.rst delete mode 100644 docs/source/upcoming_release_notes/611-enh_positioner_resizing.rst delete mode 100644 docs/source/upcoming_release_notes/615-maint_fix_ci.rst delete mode 100644 docs/source/upcoming_release_notes/616-fix_enum_handling.rst delete mode 100644 docs/source/upcoming_release_notes/618-bld_jinja_bump.rst diff --git a/docs/source/release_notes.rst b/docs/source/release_notes.rst index 0ec44a2c..00d443eb 100644 --- a/docs/source/release_notes.rst +++ b/docs/source/release_notes.rst @@ -2,6 +2,53 @@ Release History ############### +v4.0.0 (2024-08-20) +=================== + +API Breaks +---------- +- ``TyphosStatusThread`` now has a dramatically different signal API. + This is an improved version but if you were using this class take note + of the changes. Key member signals are: + - ``TyphosStatusThread.status_started`` + - ``TyphosStatusThread.status_timeout`` + - ``TyphosStatusThread.status_finished`` + - ``TyphosStatusThread.error_message`` + - ``TyphosStatusThread.status_exc`` + +Features +-------- +- Rework the design, sizing, and font scaling of the positioner row widget to address + concerns about readability and poor use of space for positioners that don't need + all of the widget components. +- Implement dynamic resizing in all directions for positioner row widgets. +- Make the timeout messages friendlier and more accurate when the + timeouts come from the ``TyphosPositionerWidget``. +- Make error messages in general (including status timeouts) clearer + when they come from the positioner device class controlled by the + ``TyphosPositionerWidget``. + +Bugfixes +-------- +- Fix an issue where the row positioner widget's resizing would peg the cpu to 100% +- Fix various issues that cause font clipping for specific motors using the positioner row widget. +- Fix various issues with enum handling in the SignalPlugin. + +Maintenance +----------- +- Fix issues with cloud-only CI failures and segfaults. +- unpin jinja, sphinx no longer incompatible +- Refactor ``TyphosStatusThread`` to facilitate timeout message changes. +- In dev/test requirements, pin pcdsdevices to current latest to fix the CI builds. + +Contributors +------------ +- canismarko +- tangkong +- zllentz + + + v3.1.1 (2024-04-12) =================== diff --git a/docs/source/upcoming_release_notes/604-perf_resize_text.rst b/docs/source/upcoming_release_notes/604-perf_resize_text.rst deleted file mode 100644 index 3ef37787..00000000 --- a/docs/source/upcoming_release_notes/604-perf_resize_text.rst +++ /dev/null @@ -1,22 +0,0 @@ -604 perf_resize_text -################# - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- Fix an issue where the row positioner widget's resizing would peg the cpu to 100% - -Maintenance ------------ -- N/A - -Contributors ------------- -- zllentz diff --git a/docs/source/upcoming_release_notes/606-enh_wait_status.rst b/docs/source/upcoming_release_notes/606-enh_wait_status.rst deleted file mode 100644 index ba43e5c0..00000000 --- a/docs/source/upcoming_release_notes/606-enh_wait_status.rst +++ /dev/null @@ -1,28 +0,0 @@ -606 enh_wait_status -################### - -API Breaks ----------- -- ``TyphosStatusThread`` now has a dramatically different signal API. - This is an improved version but if you were using this class take note - of the changes. - -Features --------- -- Make the timeout messages friendlier and more accurate when the - timeouts come from the ``TyphosPositionerWidget``. -- Make error messages in general (including status timeouts) clearer - when they come from the positioner device class controlled by the - ``TyphosPositionerWidget``. - -Bugfixes --------- -- N/A - -Maintenance ------------ -- Refactor ``TyphosStatusThread`` to facilitate timeout message changes. - -Contributors ------------- -- zllentz diff --git a/docs/source/upcoming_release_notes/607-tst_fix_ci_saga.rst b/docs/source/upcoming_release_notes/607-tst_fix_ci_saga.rst deleted file mode 100644 index 502df906..00000000 --- a/docs/source/upcoming_release_notes/607-tst_fix_ci_saga.rst +++ /dev/null @@ -1,22 +0,0 @@ -607 tst_fix_ci_saga -################### - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- Fix issues with cloud-only CI failures and segfaults. - -Contributors ------------- -- zllentz diff --git a/docs/source/upcoming_release_notes/611-enh_positioner_resizing.rst b/docs/source/upcoming_release_notes/611-enh_positioner_resizing.rst deleted file mode 100644 index 7190ca19..00000000 --- a/docs/source/upcoming_release_notes/611-enh_positioner_resizing.rst +++ /dev/null @@ -1,25 +0,0 @@ -611 enh_positioner_resizing -################# - -API Breaks ----------- -- N/A - -Features --------- -- Rework the design, sizing, and font scaling of the positioner row widget to address - concerns about readability and poor use of space for positioners that don't need - all of the widget components. -- Implement dynamic resizing in all directions for positioner row widgets. - -Bugfixes --------- -- Fix various issues that cause font clipping for specific motors using the positioner row widget. - -Maintenance ------------ -- N/A - -Contributors ------------- -- zllentz diff --git a/docs/source/upcoming_release_notes/615-maint_fix_ci.rst b/docs/source/upcoming_release_notes/615-maint_fix_ci.rst deleted file mode 100644 index 7e0e43ef..00000000 --- a/docs/source/upcoming_release_notes/615-maint_fix_ci.rst +++ /dev/null @@ -1,22 +0,0 @@ -615 maint_fix_ci -################ - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- In dev/test requirements, pin pcdsdevices to current latest to fix the CI builds. - -Contributors ------------- -- zllentz diff --git a/docs/source/upcoming_release_notes/616-fix_enum_handling.rst b/docs/source/upcoming_release_notes/616-fix_enum_handling.rst deleted file mode 100644 index 0f48a1f9..00000000 --- a/docs/source/upcoming_release_notes/616-fix_enum_handling.rst +++ /dev/null @@ -1,23 +0,0 @@ -616 fix_enum_handling -################# - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- Fix various issues with enum handling in the SignalPlugin. - -Maintenance ------------ -- N/A - -Contributors ------------- -- canismarko -- zllentz diff --git a/docs/source/upcoming_release_notes/618-bld_jinja_bump.rst b/docs/source/upcoming_release_notes/618-bld_jinja_bump.rst deleted file mode 100644 index cb18157a..00000000 --- a/docs/source/upcoming_release_notes/618-bld_jinja_bump.rst +++ /dev/null @@ -1,22 +0,0 @@ -618 bld_jinja_bump -################## - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- unpin jinja, sphinx no longer incompatible - -Contributors ------------- -- tangkong