Skip to content

Commit 2d12892

Browse files
committed
a few more documentation updates/fixes
1 parent 0b08011 commit 2d12892

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

docs/esasky/esasky.rst

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ So the above query may also be written as:
7070
7171
>>> result = ESASky.query_object_catalogs("M51", ["integral", "XMM-OM"])
7272
73-
To search in all available catalogs you can write "all" instead of a catalog
73+
To search in all available catalogs you can write ``"all"`` instead of a catalog
7474
name. The same thing will happen if you don't write any catalog name.
7575

7676
.. code-block:: python
@@ -122,14 +122,14 @@ or coordinate. To execute the same command as above you write this:
122122
123123
>>> result = ESASky.query_object_maps("M51", "all")
124124
125-
The parameters are interchangeable in the same way as in query_object_catalogs
125+
The parameters are interchangeable in the same way as in :meth:`~astroquery.esasky.ESASkyClass.query_object_catalogs`.
126126

127127
Query a region
128128
--------------
129129
The region queries work in a similar way as query_object, except that you must
130-
choose a radius as well. There are two query region methods in this module
131-
:meth:`astroquery.esasky.ESASkyClass.query_region_catalogs` and
132-
:meth:`astroquery.esasky.ESASkyClass.query_region_maps`.
130+
choose a radius as well. There are two query region methods in this module:
131+
:meth:`~astroquery.esasky.ESASkyClass.query_region_catalogs` and
132+
:meth:`~astroquery.esasky.ESASkyClass.query_region_maps`.
133133
The query returns a maximum of 2000 sources per mission.
134134

135135
To query a region either the coordinates or the object name around which to
@@ -149,7 +149,7 @@ So the above query may also be written as:
149149
150150
>>> result = ESASky.query_region_catalogs("M51", 10 * u.arcmin, ["integral", "XMM-OM"])
151151
152-
To search in all available catalogs you can write "all" instead of a catalog
152+
To search in all available catalogs you can write ``"all"`` instead of a catalog
153153
name. The same thing will happen if you don't write any catalog name.
154154

155155
.. code-block:: python
@@ -175,14 +175,15 @@ To see the result:
175175
'2:XMM-OM' with 12 column(s) and 220 row(s)
176176
'3:PLANCK-PCCS2-HFI' with 8 column(s) and 1 row(s)
177177
178-
As mentioned earlier, query_region_maps works extremely similar.
178+
As mentioned earlier, :meth:`~astroquery.esasky.ESASkyClass.query_region_maps` works extremely similar.
179179
To execute the same command as above you write this:
180180

181181
.. code-block:: python
182182
183183
>>> result = ESASky.query_region_maps("M51", 10 * u.arcmin, "all")
184184
185-
The parameters are interchangeable in the same way as in query_region_catalogs
185+
The parameters are interchangeable in the same way as in
186+
:meth:`~astroquery.esasky.ESASkyClass.query_region_catalogs`.
186187

187188
Get images
188189
----------
@@ -201,7 +202,8 @@ dictionary where the used filter is the key and the HDUList is the value.
201202
.. code-block:: python
202203
203204
>>> from astroquery.esasky import ESASky
204-
>>> images = ESASky.get_images("m51", radius="20 arcmin", missions=['Herschel', 'XMM-EPIC'])
205+
>>> images = ESASky.get_images("m51", radius="20 arcmin",
206+
... missions=['Herschel', 'XMM-EPIC'])
205207
206208
Starting download of HERSCHEL data. (12 files)
207209
Downloading Observation ID: 1342183910 from http://archives.esac.esa.int/hsa/aio/jsp/standaloneproduct.jsp?RETRIEVAL_TYPE=STANDALONE&OBSERVATION.OBSERVATION_ID=1342183910&OBSERVING_MODE.OBSERVING_MODE_NAME=PacsPhoto&INSTRUMENT.INSTRUMENT_NAME=PACS [Done]
@@ -221,7 +223,9 @@ parameter:
221223

222224
.. code-block:: python
223225
224-
>>> images = ESASky.get_images("m51", radius="20 arcmin", missions=['Herschel', 'XMM-EPIC'], download_dir="/home/user/esasky")
226+
>>> images = ESASky.get_images("m51", radius="20 arcmin",
227+
... missions=['Herschel', 'XMM-EPIC'],
228+
... download_dir="/home/user/esasky")
225229
226230
Get maps
227231
--------
@@ -232,14 +236,17 @@ it takes a `~astroquery.utils.TableList` instead of position, radius and mission
232236

233237
.. code-block:: python
234238
235-
>>> table_list = ESASky.query_region_maps("m51", radius="20 arcmin", missions=['Herschel', 'XMM-EPIC'])
239+
>>> table_list = ESASky.query_region_maps("m51", radius="20 arcmin",
240+
... missions=['Herschel', 'XMM-EPIC'])
236241
>>> images = ESASky.get_maps(table_list, download_dir="/home/user/esasky")
237242
238243
This example is equivalent to:
239244

240245
.. code-block:: python
241246
242-
>>> images = ESASky.get_images("m51", radius="20 arcmin", missions=['Herschel', 'XMM-EPIC'], download_dir="/home/user/esasky")
247+
>>> images = ESASky.get_images("m51", radius="20 arcmin",
248+
... missions=['Herschel', 'XMM-EPIC'],
249+
... download_dir="/home/user/esasky")
243250
244251
245252
Reference/API

0 commit comments

Comments
 (0)