📝 Improve docstring

Xen0Xys · May 27, 2024 · c220447 · c220447
1 parent 7999699
commit c220447
Showing 1 changed file with 11 additions and 11 deletions.
diff --git a/src/ipyaladin/aladin.py b/src/ipyaladin/aladin.py
@@ -48,15 +48,13 @@
 SupportedRegion = Union[
     typing.List[
         Union[
-            str,
             CircleSkyRegion,
             EllipseSkyRegion,
             LineSkyRegion,
             PolygonSkyRegion,
             RectangleSkyRegion,
         ]
     ],
-    str,
     CircleSkyRegion,
     EllipseSkyRegion,
     LineSkyRegion,
@@ -384,11 +382,11 @@ def add_graphic_overlay_from_region(
 
         Parameters
         ----------
-        region: str, `~regions.CircleSkyRegion`, `~regions.EllipseSkyRegion`,
+        region: `~regions.CircleSkyRegion`, `~regions.EllipseSkyRegion`,
         `~regions.LineSkyRegion`,`~regions.PolygonSkyRegion`,
-        `~regions.RectangleSkyRegion`
-            The region to add in Aladin Lite. It can be given as a standard
-            STC-string or as a supported region from the regions package
+        `~regions.RectangleSkyRegion`, `~regions.Regions`
+            The region to add in Aladin Lite. It can be given
+            as a supported region or a list of regions from the regions package
         graphic_options: keyword arguments
             The options for the graphic overlay. Use Region visual for region options.
             See graphicOverlay options  here https://cds-astro.github.io/aladin-lite/A.html
@@ -439,9 +437,10 @@ def add_overlay_from_stcs(
 
         Parameters
         ----------
-        stc_string: str
-            The STC-S string.
+        stc_string: str, list[str]
+            The STC-S string or an array of STC-S string.
         overlay_options: keyword arguments
+            The overlay options for all the STC-S string
 
         """
         warnings.warn(
@@ -450,7 +449,7 @@ def add_overlay_from_stcs(
             DeprecationWarning,
             stacklevel=2,
         )
-        self.add_overlay_from_region(stc_string, **overlay_options)
+        self.add_graphic_overlay_from_stcs(stc_string, **overlay_options)
 
     def add_graphic_overlay_from_stcs(
         self, stc_string: Union[typing.List[str], str], **overlay_options: any
@@ -459,9 +458,10 @@ def add_graphic_overlay_from_stcs(
 
         Parameters
         ----------
-        stc_string: str
-            The STC-S string.
+        stc_string: str, list[str]
+            The STC-S string or an array of STC-S string.
         overlay_options: keyword arguments
+            The overlay options for all the STC-S string
 
         """
         region_list = [stc_string] if not isinstance(stc_string, list) else stc_string