Add exceptions to docstrings

Author: mwcraig

src/astro_image_display_api/interface_definition.py

@@ -69,6 +69,16 @@ def set_cuts(self, cuts: tuple | BaseInterval, image_label: str | None = None) -
         image_label : str, optional
             The label of the image to set the cuts for. If not given and there is
             only one image loaded, the cuts for that image are set.
+
+        Raises
+        ------
+        TypeError
+            If the `cuts` parameter is not a tuple or an `astropy.visualization.BaseInterval`
+            object.
+
+        ValueError
+            If the `image_label` is not provided when there are multiple images loaded,
+            or if the `image_label` does not correspond to a loaded image.
         """
         raise NotImplementedError
 
@@ -88,6 +98,12 @@ def get_cuts(self, image_label: str | None = None) -> BaseInterval:
         -------
         cuts : `~astropy.visualization.BaseInterval`
             The Astropy interval object representing the current cuts.
+
+        Raises
+        ------
+        ValueError
+            If the `image_label` is not provided when there are multiple images loaded,
+            or if the `image_label` does not correspond to a loaded image.
         """
         raise NotImplementedError
 
@@ -105,6 +121,15 @@ def set_stretch(self, stretch: BaseStretch, image_label: str | None = None) -> N
         image_label : str, optional
             The label of the image to set the cuts for. If not given and there is
             only one image loaded, the cuts for that image are set.
+
+        Raises
+        ------
+        TypeError
+            If the `stretch` is not a valid `BaseStretch` object
+
+        ValueError
+            if the `image_label` is not provided when there are multiple images loaded
+            or if the `image_label` does not correspond to a loaded image.
         """
         raise NotImplementedError
 
@@ -194,6 +219,11 @@ def save(self, filename: str | os.PathLike, overwrite: bool = False) -> None:
         overwrite : bool, optional
             If `True`, overwrite the file if it exists. Default is
             `False`.
+
+        Raises
+        ------
+        FileExistsError
+            If the file already exists and `overwrite` is `False`.
         """
         raise NotImplementedError
 
@@ -229,6 +259,13 @@ def load_catalog(self, table: Table, x_colname: str = 'x', y_colname: str = 'y',
             A dictionary that specifies the style of the markers used to
             represent the catalog. See `ImageViewerInterface.set_catalog_style`
             for details.
+
+        Raises
+        ------
+        ValueError
+            If the `table` does not contain the required columns, or if
+            the `catalog_label` is not provided when there are multiple
+            catalogs loaded.
         """
         raise NotImplementedError
 
@@ -262,6 +299,13 @@ def set_catalog_style(
         -----
         The following shapes are supported: "circle", "square", "crosshair", "plus",
         "diamond".
+
+        Raises
+        ------
+        ValueError
+            If there are multiple catalog styles set and the user has not
+            specified a `catalog_label` for which to set the style, or if
+            an style is set for a catalog that does not exist.
         """
         raise NotImplementedError
 
@@ -270,6 +314,15 @@ def get_catalog_style(self, catalog_label: str | None = None) -> dict:
         """
         Get the style of the catalog markers.
 
+        Parameters
+        ----------
+        catalog_label : str, optional
+            The name of the catalog. If not given and there is
+            only one catalog loaded, the style for that catalog is returned.
+            If there are multiple catalogs and no label is provided, an error
+            is raised. If the label is not does not correspond to a loaded
+            catalog, an empty dictionary is returned.
+
         Returns
         -------
         dict
@@ -281,6 +334,7 @@ def get_catalog_style(self, catalog_label: str | None = None) -> dict:
         ValueError
             If there are multiple catalog styles set and the user has not
             specified a `catalog_label` for which to get the style.
+
         """
         raise NotImplementedError
 
@@ -292,8 +346,16 @@ def remove_catalog(self, catalog_label: str | list[str] | None = None) -> None:
         Parameters
         ----------
         catalog_label : str, optional
-            The name of the marker set to remove. If the value is ``"all"``,
-            then all markers will be removed.
+            The name of the catalog to remove. The value ``'*'`` can be used to
+            remove all catalogs. If not given and there is
+            only one catalog loaded, that catalog is removed.
+
+        Raises
+        ------
+        ValueError
+            If the `catalog_label` is not provided when there are multiple
+            catalogs loaded, or if the `catalog_label` does not correspond to a
+            loaded catalog.
         """
         raise NotImplementedError
 
@@ -324,6 +386,11 @@ def get_catalog(self, x_colname: str = 'x', y_colname: str = 'y',
         table : `astropy.table.Table`
             The table containing the marker positions. If no markers match the
             ``catalog_label`` parameter, an empty table is returned.
+
+        Raises
+        ------
+        ValueError
+            If the `catalog_label` is not provided when there are multiple catalogs loaded.
         """
         raise NotImplementedError
 
@@ -408,6 +475,7 @@ def get_viewport(self, sky_or_pixel: str | None = None, image_label: str | None
         -------
         ValueError
             If the `sky_or_pixel` parameter is not one of 'sky', 'pixel', or `None`, or if
-            the `image_label` is not provided when there are multiple images loaded.
+            the `image_label` is not provided when there are multiple images loaded, or if
+            the `image_label` does not correspond to a loaded image.
         """
         raise NotImplementedError