From 808fc4dc938febdddb1b58d591eb8166ef07d0ab Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Tue, 30 Nov 2021 11:45:42 -0800 Subject: [PATCH 1/2] DOC: write release notes for v2.2.0, include missing notes from v2.1.0 --- docs/source/release_notes.rst | 68 +++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) diff --git a/docs/source/release_notes.rst b/docs/source/release_notes.rst index ee417317..ee9160c4 100644 --- a/docs/source/release_notes.rst +++ b/docs/source/release_notes.rst @@ -2,6 +2,74 @@ Release History ================= +v2.2.0 (2021-11-30) +=================== + +Description +----------- +This is a feature and bugfix release to extend the customizability of +typhos suites and launcher scrips, to fix various issues in control +layer and enum handling, and to do some necessary CI maintenance. + +Enhancements / What's new +------------------------- +* Add suite options for layouts, display types, scrollbars, and + starting window size. These are all also available as CLI arguments, + with the intention of augmenting typhos suite launcher scripts. + Here are some examples: + * ``--layout grid --cols 3``: lays out the device displays in a 3-column + grid + * ``--layout flow``: lays out the device displays in a grid that adjusts + dynamically as the window is resized. + * ``--display-type embed``: starts all device displays in their embedded + state + * ``--size 1000,1000``: sets a starting size of 1000 width, 1000 height for + the suite window. + + See https://github.com/pcdshub/typhos/pull/450 + +Fixes +----- +* Respect ophyd signal enum_strs and metadata updates. Previously, these were + ignored, but these can update during the lifetime of a screen and should be + used. (https://github.com/pcdshub/typhos/pull/459) +* Identify signals that use non-EPICS control layers and handle them + appropriately. Previously, these would be misidentified as EPICS signals + and handled using the ca:// PyDM plugin, which was not correct. + (https://github.com/pcdshub/typhos/pull/463) +* Fix an issue where get_native_methods could fail. This was not observed + in the field, but it broke the test suite. + (https://github.com/pcdshub/typhos/pull/464) + +Maintenance +----------- +* Fix various issues related to the test suite stability. + + +v2.1.0 (2021-10-18) +=================== + +Description +----------- +This is a minor feature release of typhos. + +Enhancements / What's new +------------------------- +* Added option to pop out documentation frame (https://github.com/pcdshub/typhos/pull/458) + +Fixes +----- +* Fixed authorization headers on Typhos help widget redirect (https://github.com/pcdshub/typhos/pull/457) + - This allows for the latest Confluence to work with Personal Access Tokens while navigating through the page + +Maintenance +----------- +* Reduced javascript log message spam from the web view widget (part of #457) +* Reduced log message spam from variety metadata handling (part of #457) +* Fixed compatibility with pyqtgraph v0.12.3 +* Web-related widgets are now in a new submodule `typhos.web`. + + v2.0.0 (2021-08-05) =================== From c47571c41d0f9f6e522cfeb2df10b0d0ec3d7bf9 Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Tue, 30 Nov 2021 14:22:54 -0800 Subject: [PATCH 2/2] DOC: fix syntax and nitpick release note links --- docs/source/release_notes.rst | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/docs/source/release_notes.rst b/docs/source/release_notes.rst index ee9160c4..a6e552d6 100644 --- a/docs/source/release_notes.rst +++ b/docs/source/release_notes.rst @@ -17,6 +17,7 @@ Enhancements / What's new starting window size. These are all also available as CLI arguments, with the intention of augmenting typhos suite launcher scripts. Here are some examples: + * ``--layout grid --cols 3``: lays out the device displays in a 3-column grid * ``--layout flow``: lays out the device displays in a grid that adjusts @@ -26,20 +27,20 @@ Enhancements / What's new * ``--size 1000,1000``: sets a starting size of 1000 width, 1000 height for the suite window. - See https://github.com/pcdshub/typhos/pull/450 + See `#450 `_ Fixes ----- * Respect ophyd signal enum_strs and metadata updates. Previously, these were ignored, but these can update during the lifetime of a screen and should be - used. (https://github.com/pcdshub/typhos/pull/459) + used. (`#459 `_) * Identify signals that use non-EPICS control layers and handle them appropriately. Previously, these would be misidentified as EPICS signals and handled using the ca:// PyDM plugin, which was not correct. - (https://github.com/pcdshub/typhos/pull/463) + (`#463 `_) * Fix an issue where get_native_methods could fail. This was not observed in the field, but it broke the test suite. - (https://github.com/pcdshub/typhos/pull/464) + (`#464 `_) Maintenance ----------- @@ -55,17 +56,23 @@ This is a minor feature release of typhos. Enhancements / What's new ------------------------- -* Added option to pop out documentation frame (https://github.com/pcdshub/typhos/pull/458) +* Added option to pop out documentation frame + (`#458 `_) Fixes ----- -* Fixed authorization headers on Typhos help widget redirect (https://github.com/pcdshub/typhos/pull/457) - - This allows for the latest Confluence to work with Personal Access Tokens while navigating through the page +* Fixed authorization headers on Typhos help widget redirect + (`#457 `_) + + * This allows for the latest Confluence to work with Personal + Access Tokens while navigating through the page Maintenance ----------- -* Reduced javascript log message spam from the web view widget (part of #457) -* Reduced log message spam from variety metadata handling (part of #457) +* Reduced javascript log message spam from the web view widget + (part of `#457 `_) +* Reduced log message spam from variety metadata handling + (part of `#457 `_) * Fixed compatibility with pyqtgraph v0.12.3 * Web-related widgets are now in a new submodule `typhos.web`.