EUCLIDSWRQ-250 Review documentation

Author: Jorge Fernandez Hernandez

astroquery/esa/euclid/core.py

@@ -1519,27 +1519,32 @@ def __is_multiple(self, value):
     def get_sia(self, *, coordinates, radius=1.0, search_type='CIRCLE', calibration=2, instrument='ALL', band=None,
                 collection='sedm', dsr_part1=None, dsr_part2=None, dsr_part3=None, output_file=None, verbose=False):
         """
-        Access the Euclid Observation Images by VO SIAP v2.0. This service will return public images from Calibrated
-        and Stacked NISP and VIS images, MER Mosaics from VIS and NISP and Level 1 (RAW) images for NISP and VIS
+        Query the Euclid Observation Images service through the IVOA SIAP 2.0 interface. The service provides access to
+        public calibrated and stacked VIS and NISP images, MER mosaics, and Level 1 (raw) VIS and NISP observations.
 
         Parameters
         ----------
         coordinates: str or SkyCoord, mandatory, default None
-            coordinates of the center in the cone search
-        radius: float or quantity, optional, default value 1 degree
-            radius in degrees for (int, float) or quantity of the cone_search
-        search_type : str, mandatory, default CIRCLE
-            search region: CIRCLE or BOX
+            Center of the search region.
+        radius: float or quantity, optional, default value 1.0 degree
+            Radius of the search region. If a numeric value is provided, it is interpreted in degrees. An
+            astropy.units.Quantity may also be supplied. If "BOX" uses this value as half-width or width
+        search_type : str, optional, default CIRCLE
+            Shape of the search region. Supported values are "CIRCLE" and "BOX".
         calibration: int, optional, default 2
-            calibration level according to ObsCore VO standard: 0 (raw instrumental data), 1 (instrumental data in a
-            standard format), 2 (science ready data) or 3 (enhanced data products).
-        instrument: str, mandatory, default ALL
-            instrument name: ALL, VIS or NISP
+            Calibration level following the ObsCore data model:
+                0: raw instrumental data
+                1: instrumental data in a standard format
+                2: science-ready data
+                3: enhanced data products
+        instrument: str, optional, default ALL
+            Instrument to query. Supported values are "ALL", "VIS", and "NISP".
         band: str, optional, default None
-            filter name only valid if instrument is different from ALL: VIS for instrument VIS or NIR_H, NIR_J, NIR_Y
-            or NISP for instrument NISP
-        collection : str, mandatory, default sedm
-            the name of the data collection
+            Filter name. This parameter is ignored when instrument="ALL". Valid values are:
+                0: "VIS" for the VIS instrument
+                1: "NIR_Y", "NIR_J", "NIR_H", or "NISP" for the NISP instrument
+        collection : str, optional, default sedm
+            Name of the data collection.
         dsr_part1: str, optional, default None
             the data set release part 1: for OTF environment, the activity code; for REG and IDR, the target environment
         dsr_part2: str, optional, default None
@@ -1548,13 +1553,15 @@ def get_sia(self, *, coordinates, radius=1.0, search_type='CIRCLE', calibration=
         dsr_part3: str, optional, default None
             the data set release part 3: for OTF, REG and IDR environment, the version (an integer greater than 1)
         output_file : string, optional, default None
-            file where the results are saved.
+            Path of the output file. If provided, the query results are written to this file.
         verbose : bool, optional, default 'False'
             flag to display information about the process
 
         Returns
         -------
-        An astropy.table or a votable file
+        astropy.table.Table or str
+            Query results as an `astropy.table.Table`. If `output_file` is
+            specified, the results are also written as a VOTable to the given file.
         """
 
         valid_search_types = {'CIRCLE', 'BOX'}