Merge pull request #784 from pllim/doc-clarify-share-image

DOC: Clarify share_image in Mosviz parser
spacetelescope · Aug 19, 2021 · 213ab0a · 213ab0a
2 parents 11c68b4 + 0e03dbe
commit 213ab0a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/jdaviz/configs/mosviz/helper.py b/jdaviz/configs/mosviz/helper.py
@@ -212,6 +212,12 @@ def load_images(self, data_obj, data_labels=None, share_image=0):
             String representing the label for the data item loaded via
             ``data_obj``. Can be a list of strings representing data labels
             for each item in ``data_obj`` if  ``data_obj`` is a list.
+        share_image : int, optional
+            If 0, images are treated as applying to individual spectra. If non-zero,
+            a single image will be shared by multiple spectra so that clicking a
+            different row in the table does not reload the displayed image.
+            Currently, if non-zero, the provided number must match the number of
+            spectra.
         """
         super().load_data(data_obj, parser_reference="mosviz-image-parser",
                           data_labels=data_labels, share_image=share_image)

diff --git a/jdaviz/configs/mosviz/plugins/parsers.py b/jdaviz/configs/mosviz/plugins/parsers.py
@@ -259,6 +259,8 @@ def mos_image_parser(app, data_obj, data_labels=None, share_image=0):
         If 0, images are treated as applying to individual spectra. If non-zero,
         a single image will be shared by multiple spectra so that clicking a
         different row in the table does not reload the displayed image.
+        Currently, if non-zero, the provided number must match the number of
+        spectra.
     """
 
     if data_obj is None: