From e22aa080f07b543bd6f2ed029098b2b4890f8f41 Mon Sep 17 00:00:00 2001 From: Kyle Conroy Date: Tue, 19 Nov 2024 13:32:28 -0500 Subject: [PATCH] add docstring for delete_subsets --- jdaviz/configs/imviz/plugins/orientation/orientation.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/jdaviz/configs/imviz/plugins/orientation/orientation.py b/jdaviz/configs/imviz/plugins/orientation/orientation.py index 350c98a7de..3659ab4b02 100644 --- a/jdaviz/configs/imviz/plugins/orientation/orientation.py +++ b/jdaviz/configs/imviz/plugins/orientation/orientation.py @@ -52,7 +52,7 @@ class Orientation(PluginTemplateMixin, ViewerSelectMixin): * :meth:`~jdaviz.core.template_mixin.PluginTemplateMixin.close_in_tray` * ``align_by`` (`~jdaviz.core.template_mixin.SelectPluginComponent`) * ``wcs_fast_approximation`` - * :meth:`delete_subsets`` + * :meth:`delete_subsets` * ``viewer`` * ``orientation`` * ``rotation_angle`` @@ -289,6 +289,9 @@ def _on_subset_change(self, msg): self.need_clear_subsets = len(self.app.data_collection.subset_groups) > 0 def delete_subsets(self): + """ + Delete all subsets app-wide. Required before changing ``align_by``. + """ # subsets will be deleted on changing link type: for subset_group in self.app.data_collection.subset_groups: self.app.data_collection.remove_subset_group(subset_group)