Merge pull request #2763 from ceb8/cache_documentation

Caching documentation update

Author: bsipocz

astroquery/atomic/core.py

@@ -140,6 +140,10 @@ def query_object(self, *, wavelength_range=None, wavelength_type=None, wavelengt
             Angular momentum, Transition probability and Level energies
             respectively.
 
+        cache : bool
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
+
         Returns
         -------
         result : `~astropy.table.Table`

astroquery/casda/core.py

@@ -113,8 +113,9 @@ def query_region_async(self, coordinates, *, radius=1*u.arcmin, height=None, wid
             the width for a box region
         get_query_payload : bool, optional
             Just return the dict of HTTP request parameters.
-        cache: bool, optional
-            Use the astroquery internal query result cache
+        cache : bool
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
 
         Returns
         -------

astroquery/esa/hsa/core.py

@@ -65,6 +65,9 @@ def download_data(self, *, retrieval_type="OBSERVATION", observation_id=None,
             values: ALL, AUXILIARY, CALIBRATION, LEVEL0, LEVEL0_5, LEVEL1, LEVEL2, LEVEL2_5, LEVEL3, ALL-LEVEL3
         download_dir : string, optional
             The directory in which the file will be downloaded
+        cache : bool
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
 
         Returns
         -------

astroquery/esa/xmm_newton/core.py

@@ -104,6 +104,9 @@ def download_data(self, observation_id, *, filename=None, verbose=False,
         extension : string
             file format, optional, by default all formats
             values: ASC, ASZ, FTZ, HTM, IND, PDF, PNG
+        cache : bool
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
 
         Returns
         -------

astroquery/eso/core.py

@@ -312,7 +312,8 @@ def list_instruments(self, *, cache=True):
         -------
         instrument_list : list of strings
         cache : bool
-            Cache the response for faster subsequent retrieval
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
 
         """
         if self._instrument_list is None:
@@ -335,7 +336,8 @@ def list_surveys(self, *, cache=True):
         -------
         survey_list : list of strings
         cache : bool
-            Cache the response for faster subsequent retrieval
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
         """
         if self._survey_list is None:
             survey_list_response = self._request(
@@ -372,7 +374,8 @@ def query_surveys(self, *, surveys='', cache=True,
             specified as a string, should be a comma-separated list of
             survey names.
         cache : bool
-            Cache the response for faster subsequent retrieval
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
 
         Returns
         -------
@@ -436,7 +439,8 @@ def query_main(self, *, column_filters={}, columns=[],
             ``column_filters`` and ``columns`` for the requested
             ``instrument``.
         cache : bool
-            Cache the response for faster subsequent retrieval.
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
 
         Returns
         -------
@@ -473,7 +477,8 @@ def query_instrument(self, instrument, *, column_filters={}, columns=[],
             ``column_filters`` and ``columns`` for the requested
             ``instrument``.
         cache : bool
-            Cache the response for faster subsequent retrieval.
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
 
         Returns
         -------
@@ -549,6 +554,9 @@ def get_headers(self, product_ids, *, cache=True):
         ----------
         product_ids : either a list of strings or a `~astropy.table.Column`
             List of data product IDs.
+        cache : bool
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
 
         Returns
         -------

astroquery/heasarc/core.py

@@ -41,6 +41,9 @@ def query_async(self, request_payload, *, cache=True, url=None):
         """
         Submit a query based on a given request_payload. This allows detailed
         control of the query to be submitted.
+
+        cache (bool) defaults to True. If set overrides global caching behavior.
+        See :ref:`caching documentation <astroquery_cache>`.
         """
 
         if url is None:
@@ -53,6 +56,9 @@ def query_async(self, request_payload, *, cache=True, url=None):
     def query_mission_list(self, *, cache=True, get_query_payload=False):
         """
         Returns a list of all available mission tables with descriptions
+
+        cache (bool) defaults to True. If set overrides global caching behavior.
+        See :ref:`caching documentation <astroquery_cache>`.
         """
         request_payload = self._args_to_payload(
             entry='none',
@@ -91,6 +97,9 @@ def query_mission_cols(self, mission, *, cache=True, get_query_payload=False,
             * Standard      : Return default table columns
             * All (default) : Return all table columns
             * <custom>      : User defined csv list of columns to be returned
+        cache : bool, optional
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
         All other parameters have no effect
         """
 
@@ -121,6 +130,9 @@ def query_object_async(self, object_name, mission, *,
             parameter.
         mission : str
             Mission table to search from
+        cache : bool
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
         **kwargs :
             see `~astroquery.heasarc.HeasarcClass._args_to_payload` for list
             of additional parameters that can be used to refine search query
@@ -159,6 +171,9 @@ def query_region_async(self, position: Union[coordinates.SkyCoord, str],
         radius :
             Astropy Quantity object, or a string that can be parsed into one.
             e.g., '1 degree' or 1*u.degree.
+        cache : bool
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
         **kwargs :
             see `~astroquery.heasarc.HeasarcClass._args_to_payload` for list
             of additional parameters that can be used to refine search query

astroquery/ipac/irsa/core.py

@@ -227,7 +227,6 @@ def list_catalogs(self, full=False, cache=False):
         full : bool
             If True returns the full schema VOTable. If False returns a dictionary of the table names and
             their description.
-
         """
         tap_tables = Irsa.query_tap("SELECT * FROM TAP_SCHEMA.tables")
 
@@ -239,6 +238,7 @@ def list_catalogs(self, full=False, cache=False):
     # TODO, deprecate this as legacy
     def print_catalogs(self):
         catalogs = self.list_catalogs()
+
         for catname in catalogs:
             print("{:30s}  {:s}".format(catname, catalogs[catname]))
 

astroquery/ipac/irsa/ibe/core.py

@@ -258,7 +258,8 @@ def list_missions(self, *, cache=True):
         Parameters
         ----------
         cache : bool
-            Cache the query result
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
         """
         if hasattr(self, '_missions') and cache:
             # extra level caching to avoid redoing the BeautifulSoup parsing
@@ -288,7 +289,8 @@ def list_datasets(self, *, mission=None, cache=True):
             `~astroquery.ipac.irsa.ibe.IbeClass.list_missions`.  Defaults to the
             configured Mission
         cache : bool
-            Cache the query result
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
 
         Returns
         -------
@@ -331,7 +333,8 @@ def list_tables(self, *, mission=None, dataset=None, cache=True):
             A dataset name.  Must be one of the valid dataset from
             ``list_datsets(mission)``.  Defaults to the configured Dataset
         cache : bool
-            Cache the query result
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
 
         Returns
         -------

astroquery/jplhorizons/core.py

@@ -580,6 +580,10 @@ def ephemerides_async(self, *, airmass_lessthan=99,
         extra_precision : boolean, optional
             Enables extra precision in RA and DEC values; default: False
 
+        cache : bool
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
+
 
         Returns
         -------
@@ -825,6 +829,10 @@ def elements_async(self, *, get_query_payload=False,
             Return raw data as obtained by JPL Horizons without parsing the data
             into a table, default: False
 
+        cache : bool
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
+
 
         Returns
         -------
@@ -1058,6 +1066,10 @@ def vectors_async(self, *, get_query_payload=False,
             Triggers output of time-varying difference between TDB and UT
             time-scales. Default: False
 
+        cache : bool
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
+
 
         Returns
         -------

astroquery/jplsbdb/core.py

@@ -107,6 +107,9 @@ def query_async(self, targetid, *, id_type='search',
         get_uri : boolean, optional
             Add the query URI to the output as ``query_uri`` field.
             Default: ``False``
+        cache : bool
+            Defaults to True. If set overrides global caching behavior.
+            See :ref:`caching documentation <astroquery_cache>`.
 
         Returns
         -------