From d78260df7605b04879f48875613f36482e990dfa Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Mon, 8 May 2023 15:56:37 -0700 Subject: [PATCH 1/3] DOC: run the release notes script --- docs/source/releases.rst | 17 ++++++++++++++ .../308-enh_post_md-hook.rst | 22 ------------------- .../310-mnt_missing_key.rst | 22 ------------------- 3 files changed, 17 insertions(+), 44 deletions(-) delete mode 100644 docs/source/upcoming_release_notes/308-enh_post_md-hook.rst delete mode 100644 docs/source/upcoming_release_notes/310-mnt_missing_key.rst diff --git a/docs/source/releases.rst b/docs/source/releases.rst index c8f4ff65..4b9e2e30 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -2,6 +2,23 @@ Release History ############### +v2.2.0 (2023-05-08) +=================== + +Features +-------- +- Adds a hook in happi.loader.from_container that runs the method ``post_happi_md`` on an instantiated object after the metadata container has been attached. This allows a clear method for objects to interact with happi metadata if desired. + +Maintenance +----------- +- Makes HappiDeviceTreeView more tolerant of items with missing metadata keys. items missing the key used to group the tree view will be organized into a catch-all "[KEY NOT FOUND]" group + +Contributors +------------ +- tangkong + + + v2.1.0 (2023-04-03) =================== diff --git a/docs/source/upcoming_release_notes/308-enh_post_md-hook.rst b/docs/source/upcoming_release_notes/308-enh_post_md-hook.rst deleted file mode 100644 index 6de654b3..00000000 --- a/docs/source/upcoming_release_notes/308-enh_post_md-hook.rst +++ /dev/null @@ -1,22 +0,0 @@ -308 enh_post_md-hook -################### - -API Changes ------------ -- N/A - -Features --------- -- Adds a hook in happi.loader.from_container that runs the method ``post_happi_md`` on an instantiated object after the metadata container has been attached. This allows a clear method for objects to interact with happi metadata if desired. - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- tangkong diff --git a/docs/source/upcoming_release_notes/310-mnt_missing_key.rst b/docs/source/upcoming_release_notes/310-mnt_missing_key.rst deleted file mode 100644 index 2b602d64..00000000 --- a/docs/source/upcoming_release_notes/310-mnt_missing_key.rst +++ /dev/null @@ -1,22 +0,0 @@ -310 mnt_missing_key -################### - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- Makes HappiDeviceTreeView more tolerant of items with missing metadata keys. items missing the key used to group the tree view will be organized into a catch-all "[KEY NOT FOUND]" group - -Contributors ------------- -- tangkong From 189f3af6486e8aa31c9dd58cda517f2465792a36 Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Mon, 8 May 2023 15:58:07 -0700 Subject: [PATCH 2/3] DOC: drop the line length a bit for easier terminal reading --- docs/source/releases.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/source/releases.rst b/docs/source/releases.rst index 4b9e2e30..da5d37b4 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -7,11 +7,17 @@ v2.2.0 (2023-05-08) Features -------- -- Adds a hook in happi.loader.from_container that runs the method ``post_happi_md`` on an instantiated object after the metadata container has been attached. This allows a clear method for objects to interact with happi metadata if desired. +- Adds a hook in happi.loader.from_container that runs the method + ``post_happi_md`` on an instantiated object after the metadata + container has been attached. + This allows a clear method for objects to interact with + happi metadata if desired. Maintenance ----------- -- Makes HappiDeviceTreeView more tolerant of items with missing metadata keys. items missing the key used to group the tree view will be organized into a catch-all "[KEY NOT FOUND]" group +- Makes HappiDeviceTreeView more tolerant of items with missing metadata keys. + items missing the key used to group the tree view will be organized + into a catch-all "[KEY NOT FOUND]" group. Contributors ------------ From 5f66e40a0059f520a8a5c7fb26dae10551ec007f Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Mon, 8 May 2023 16:32:22 -0700 Subject: [PATCH 3/3] DOC: fix missing backticks and missing capital letter from PR review Co-authored-by: Ken Lauer --- docs/source/releases.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/releases.rst b/docs/source/releases.rst index da5d37b4..db585373 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -7,7 +7,7 @@ v2.2.0 (2023-05-08) Features -------- -- Adds a hook in happi.loader.from_container that runs the method +- Adds a hook in ``happi.loader.from_container`` that runs the method ``post_happi_md`` on an instantiated object after the metadata container has been attached. This allows a clear method for objects to interact with @@ -15,8 +15,8 @@ Features Maintenance ----------- -- Makes HappiDeviceTreeView more tolerant of items with missing metadata keys. - items missing the key used to group the tree view will be organized +- Makes ``HappiDeviceTreeView`` more tolerant of items with missing metadata keys. + Items missing the key used to group the tree view will be organized into a catch-all "[KEY NOT FOUND]" group. Contributors