Updated ESASky docs

Author: imbasimba

docs/esasky/esasky.rst

@@ -83,22 +83,22 @@ For instance to query an object around M51 in the Hubble catalog:
 .. code-block:: python
 
     >>> from astroquery.esasky import ESASky
-    >>> result = ESASky.query_object_catalogs("M51", "HSC")
+    >>> result = ESASky.query_object_catalogs(position="M51", missions="HSC")
 
 Note that the catalog may also be specified as a list.
 So the above query may also be written as:
 
 .. code-block:: python
 
-    >>> result = ESASky.query_object_catalogs("M51", ["HSC", "XMM-OM"])
+    >>> result = ESASky.query_object_catalogs(position="M51", missions=["HSC", "XMM-OM"])
 
 To search in all available catalogs you can write ``"all"`` instead of a catalog
 name. The same thing will happen if you don't write any catalog name.
 
 .. code-block:: python
 
-    >>> result = ESASky.query_object_catalogs("M51", "all")
-    >>> result = ESASky.query_object_catalogs("M51")
+    >>> result = ESASky.query_object_catalogs(position="M51", missions="all")
+    >>> result = ESASky.query_object_catalogs(position="M51")
 
 To see the result:
 
@@ -148,8 +148,8 @@ object or coordinate. To execute the same command as above you write this:
 
 .. code-block:: python
 
-    >>> result = ESASky.query_object_maps("M51", "all")
-    >>> result = ESASky.query_object_spectra("M51", "all")
+    >>> result = ESASky.query_object_maps(position="M51", missions="all")
+    >>> result = ESASky.query_object_spectra(position="M51", missions="all")
 
 The parameters are interchangeable in the same way as in :meth:`~astroquery.esasky.ESASkyClass.query_object_catalogs`.
 
@@ -173,29 +173,29 @@ For instance to query region around M51 in the HSC catalog:
 
     >>> from astroquery.esasky import ESASky
     >>> import astropy.units as u
-    >>> result = ESASky.query_region_catalogs("M51", 10 * u.arcmin, "HSC")
+    >>> result = ESASky.query_region_catalogs(position="M51", radius=10 * u.arcmin, catalogs="HSC")
 
 Note that the catalog may also be specified as a list.
 So the above query may also be written as:
 
 .. code-block:: python
 
-    >>> result = ESASky.query_region_catalogs("M51", 10 * u.arcmin, ["HSC", "XMM-OM"])
+    >>> result = ESASky.query_region_catalogs(position="M51", radius=10 * u.arcmin, catalogs=["HSC", "XMM-OM"])
 
 To search in all available catalogs you can write ``"all"`` instead of a catalog
 name. The same thing will happen if you don't write any catalog name.
 
 .. code-block:: python
 
-    >>> result = ESASky.query_region_catalogs("M51", 10 * u.arcmin, "all")
-    >>> result = ESASky.query_region_catalogs("M51", 10 * u.arcmin)
+    >>> result = ESASky.query_region_catalogs(position="M51", radius=10 * u.arcmin, catalogs="all")
+    >>> result = ESASky.query_region_catalogs(position="M51", radius=10 * u.arcmin)
 
 In the same manner, the radius can be specified with either
 a string or any `~astropy.units.Quantity`
 
 .. code-block:: python
 
-    >>> result = ESASky.query_region_catalogs("M51", "10 arcmin")
+    >>> result = ESASky.query_region_catalogs(position="M51", radius="10 arcmin")
 
 To see the result:
 
@@ -228,14 +228,14 @@ To execute the same command as above you write this:
 
 .. code-block:: python
 
-    >>> result = ESASky.query_region_maps("M51", 10 * u.arcmin, "all")
-    >>> result = ESASky.query_region_spectra("M51", 10 * u.arcmin, "all")
+    >>> result = ESASky.query_region_maps(position="M51", radius=10 * u.arcmin, missions="all")
+    >>> result = ESASky.query_region_spectra(position="M51", radius=10 * u.arcmin, missions="all")
 
 The parameters are interchangeable in the same way as in
 :meth:`~astroquery.esasky.ESASkyClass.query_region_catalogs`.
 
 Get the metadata of specific observations or sources
---------------
+----------------------------------------------------
 If you already know the observation ID's or source names of interest,
 you can get their related metadata directly with
 :meth:`~astroquery.esasky.ESASkyClass.query_ids_maps`,
@@ -271,7 +271,7 @@ dictionary where the used filter is the key and the HDUList is the value.
 .. code-block:: python
 
     >>> from astroquery.esasky import ESASky
-    >>> images = ESASky.get_images("m51", radius="20 arcmin",
+    >>> images = ESASky.get_images(position="m51", radius="20 arcmin",
     ...                            missions=['Herschel', 'ISO-IR'])
     Starting download of HERSCHEL data. (25 files)
     Downloading Observation ID: 1342188589 from http://archives.esac.esa.int/hsa/whsa-tap-server/data?RETRIEVAL_TYPE=STANDALONE&observation_oid=8618001&DATA_RETRIEVAL_ORIGIN=UI [Done]
@@ -291,7 +291,7 @@ To do that you just have to use the parameter observation_id instead of target a
 .. code-block:: python
 
     >>> from astroquery.esasky import ESASky
-    >>> images = ESASky.get_images("m51", radius="20 arcmin",
+    >>> images = ESASky.get_images(position="m51", radius="20 arcmin",
     ...                            missions=['Herschel', 'ISO-IR'])
 
 Note that the fits files also are stored to disk. By default they are saved to
@@ -312,15 +312,15 @@ it takes a `~astroquery.utils.TableList` instead of position, radius and mission
 
 .. code-block:: python
 
-    >>> table_list = ESASky.query_region_maps("m51", radius="20 arcmin",
+    >>> table_list = ESASky.query_region_maps(position="m51", radius="20 arcmin",
     ...                                       missions=['Herschel', 'ISO-IR'])
-    >>> images = ESASky.get_maps(table_list, download_dir="/home/user/esasky")
+    >>> images = ESASky.get_maps(query_table_list=table_list, download_dir="/home/user/esasky")
 
 This example is equivalent to:
 
 .. code-block:: python
 
-    >>> images = ESASky.get_images("m51", radius="20 arcmin",
+    >>> images = ESASky.get_images(position="m51", radius="20 arcmin",
     ...                            missions=['Herschel', 'ISO-IR'],
     ...                            download_dir="/home/user/esasky")
 
@@ -342,7 +342,7 @@ three-level dictionary.
 .. code-block:: python
 
     >>> from astroquery.esasky import ESASky
-    >>> spectra = ESASky.get_spectra("m51", radius="20 arcmin",
+    >>> spectra = ESASky.get_spectra(position="m51", radius="20 arcmin",
     ...                            missions=['Herschel', 'XMM-NEWTON'])
     >>> spectra = ESASky.get_spectra(observation_ids=["02101201", "z1ax0102t"],
     ...                              missions=["ISO-IR", "HST-UV"])
@@ -351,9 +351,9 @@ or
 
 .. code-block:: python
 
-    >>> table_list = ESASky.query_region_spectra("m51", radius="20 arcmin",
+    >>> table_list = ESASky.query_region_spectra(position="m51", radius="20 arcmin",
     ...                                       missions=['Herschel', 'XMM-NEWTON'])
-    >>> spectra = ESASky.get_spectra_from_table(table_list, download_dir="/home/user/esasky")
+    >>> spectra = ESASky.get_spectra_from_table(query_table_list=table_list, download_dir="/home/user/esasky")
 
 The response is structured in a dictionary like this:
 
@@ -376,7 +376,7 @@ Here is another example for Herschel, since it is a bit special:
     >>> result = ESASky.query_region_spectra(position='M51', radius='1arcmin', missions=['HERSCHEL'])
     >>> herschel_result = result['HERSCHEL']
     >>> herschel_result['observation_id', 'target_name', 'instrument', 'observing_mode_name', 'band', 'duration'].pprint()
-    >>> spectra = ESASky.get_spectra_from_table([('HERSCHEL', herschel_result)], download_dir='Spectra_new')
+    >>> spectra = ESASky.get_spectra_from_table(query_table_list=[('HERSCHEL', herschel_result)], download_dir='Spectra_new')
     >>> spectra['HERSCHEL']['1342211195']['red'].keys()
     >>> spectra['HERSCHEL']['1342211195']['red']['HPSTBRRS'].info()