Restore verbosity default and update docstrings

astropy · Sep 29, 2022 · 04d6b0a · 04d6b0a
1 parent b5271fc
commit 04d6b0a
Showing 1 changed file with 12 additions and 10 deletions.
diff --git a/pyvo/dal/sia.py b/pyvo/dal/sia.py
@@ -46,7 +46,7 @@
 
 
 def search(
-        url, pos, size=1.0, format=None, intersect=None, verbosity=None,
+        url, pos, size=1.0, format=None, intersect=None, verbosity=2,
         **keywords):
     """
     submit a simple SIA query that requests images overlapping a given region
@@ -64,7 +64,7 @@ def search(
         converted if it's a iterable containing scalars,
         assuming decimal degrees.
     format : str
-        the image format(s) of interest.  "all" (default)
+        the image format(s) of interest.  "all" (server-side default)
         indicates all available formats; "graphic" indicates
         graphical images (e.g. jpeg, png, gif; not FITS);
         "metadata" indicates that no images should be
@@ -78,14 +78,15 @@ def search(
         ========= ======================================================
         COVERS    select images that completely cover the search region
         ENCLOSED  select images that are complete enclosed by the region
-        OVERLAPS  select any image that overlaps with the search region
+        OVERLAPS  select any image that overlaps the search region (server-side default)
         CENTER    select images whose center is within the search region
         ========= ======================================================
 
     verbosity : int
         an integer value that indicates the volume of columns
         to return in the result table.  0 means the minimum
         set of columsn, 3 means as many columns as are  available.
+        (client-side default == 2)
     **keywords :
         additional parameters can be given via arbitrary
         case insensitive keyword arguments. Where there is overlap
@@ -187,7 +188,7 @@ def columns(self):
 
     def search(
             self, pos, size=1.0, format=None, intersect=None,
-            verbosity=None, **keywords):
+            verbosity=2, **keywords):
         """
         submit a SIA query to this service with the given parameters.
 
@@ -205,7 +206,7 @@ def search(
             the size of the rectangular region around pos.
             assuming icrs decimal degrees if unit is not specified.
         format : str
-            the image format(s) of interest.  "all" (default)
+            the image format(s) of interest.  "all" (server-side default)
             indicates all available formats; "graphic" indicates
             graphical images (e.g. jpeg, png, gif; not FITS);
             "metadata" indicates that no images should be
@@ -219,14 +220,15 @@ def search(
             ========= ======================================================
             COVERS    select images that completely cover the search region
             ENCLOSED  select images that are complete enclosed by the region
-            OVERLAPS  select any image that overlaps with the search region
+            OVERLAPS  select any image that overlaps the search region (server-side default)
             CENTER    select images whose center is within the search region
             ========= ======================================================
 
         verbosity : int
             an integer value that indicates the volume of columns
             to return in the result table.  0 means the minimum
             set of columns, 3 means as many columns as are  available.
+            (client-side default == 2)
         **keywords :
             additional parameters can be given via arbitrary
             case insensitive keyword arguments. Where there is overlap
@@ -277,7 +279,7 @@ def create_query(
             the size of the rectangular region around pos.
             assuming icrs decimal degrees if unit is not specified.
         format : str
-            the image format(s) of interest.  "all" (default)
+            the image format(s) of interest.  "all" (server-side default)
             indicates all available formats; "graphic" indicates
             graphical images (e.g. jpeg, png, gif; not FITS);
             "metadata" indicates that no images should be
@@ -291,7 +293,7 @@ def create_query(
             ========= ======================================================
             COVERS    select images that completely cover the search region
             ENCLOSED  select images that are complete enclosed by the region
-            OVERLAPS  select any image that overlaps with the search region
+            OVERLAPS  select any image that overlaps the search region (server-side default)
             CENTER    select images whose center is within the search region
             ========= ======================================================
 
@@ -364,7 +366,7 @@ def __init__(
             the size of the rectangular region around pos.
             assuming icrs decimal degrees if unit is not specified.
         format : str
-            the image format(s) of interest.  "all" (default)
+            the image format(s) of interest.  "all" (server-side default)
             indicates all available formats; "graphic" indicates
             graphical images (e.g. jpeg, png, gif; not FITS);
             "metadata" indicates that no images should be
@@ -378,7 +380,7 @@ def __init__(
             ========= ======================================================
             COVERS    select images that completely cover the search region
             ENCLOSED  select images that are complete enclosed by the region
-            OVERLAPS  select any image that overlaps with the search region
+            OVERLAPS  select any image that overlaps the search region (server-side default)
             CENTER    select images whose center is within the search region
             ========= ======================================================