Skip to content

Commit d8332e3

Browse files
committed
Fix documentation build
The newly released `numpydoc` 1.2 emits many warnings about docstrings. The causes of these warnings are addressed by this commit and the documentation build should now succeed.
1 parent f4a0664 commit d8332e3

File tree

9 files changed

+20
-18
lines changed

9 files changed

+20
-18
lines changed

astroquery/alma/core.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -397,6 +397,8 @@ def query_sia(self, pos=None, band=None, time=None, pol=None,
397397
398398
Parameters
399399
----------
400+
**kwargs
401+
Parameters for the SIA service.
400402
401403
Returns
402404
-------

astroquery/ipac/irsa/irsa_dust/core.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ def get_images_async(self, coordinate, radius=None, image_type=None,
123123
to remote server. Defaults to `False`.
124124
125125
Returns
126-
--------
126+
-------
127127
list : list
128128
A list of context-managers that yield readable file-like objects.
129129
"""
@@ -146,7 +146,7 @@ def get_image_list(self, coordinate, radius=None, image_type=None,
146146
of URLs to the Irsa-Dust images.
147147
148148
Parameters
149-
-----------
149+
----------
150150
coordinate : str
151151
Can be either the name of an object or a coordinate string
152152
If a name, must be resolvable by NED, SIMBAD, 2MASS, or SWAS.
@@ -169,7 +169,7 @@ def get_image_list(self, coordinate, radius=None, image_type=None,
169169
to remote server. Defaults to `False`.
170170
171171
Returns
172-
--------
172+
-------
173173
url_list : list
174174
A list of URLs to the FITS images corresponding to the queried
175175
object.
@@ -203,7 +203,7 @@ def get_extinction_table(self, coordinate, radius=None, timeout=TIMEOUT,
203203
server. Defaults to `~astroquery.ipac.irsa.irsa_dust.IrsaDustClass.TIMEOUT`.
204204
205205
Returns
206-
--------
206+
-------
207207
table : `~astropy.table.Table`
208208
"""
209209
readable_obj = self.get_extinction_table_async(
@@ -289,7 +289,7 @@ def get_query_table(self, coordinate, radius=None,
289289
Defaults to `~astroquery.ipac.irsa.irsa_dust.IrsaDustClass.DUST_SERVICE_URL`.
290290
291291
Returns
292-
--------
292+
-------
293293
table : `~astropy.table.Table`
294294
Table representing the query results, (all or as per specified).
295295
"""

astroquery/ipac/ned/core.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -385,7 +385,7 @@ def get_images_async(self, object_name, get_query_payload=False,
385385
request. Defaults to `False`
386386
387387
Returns
388-
--------
388+
-------
389389
A list of context-managers that yield readable file-like objects
390390
391391
"""
@@ -438,7 +438,7 @@ def get_spectra_async(self, object_name, get_query_payload=False,
438438
request. Defaults to `False`
439439
440440
Returns
441-
--------
441+
-------
442442
A list of context-managers that yield readable file-like objects
443443
444444
"""

astroquery/jplspec/core.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,12 +191,12 @@ def get_species_table(self, catfile='catdir.cat'):
191191
| (I6,X, A13, I6, 7F7.4, I2)
192192
193193
Parameters
194-
-----------
194+
----------
195195
catfile : str, name of file, default 'catdir.cat'
196196
The catalog file, installed locally along with the package
197197
198198
Returns
199-
--------
199+
-------
200200
Table: `~astropy.table.Table`
201201
| TAG : The species tag or molecular identifier.
202202
| NAME : An ASCII name for the species.

astroquery/linelists/cdms/core.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -254,12 +254,12 @@ def get_species_table(self, catfile='catdir.cat'):
254254
The table is derived from https://cdms.astro.uni-koeln.de/classic/entries/partition_function.html
255255
256256
Parameters
257-
-----------
257+
----------
258258
catfile : str, name of file, default 'catdir.cat'
259259
The catalog file, installed locally along with the package
260260
261261
Returns
262-
--------
262+
-------
263263
Table: `~astropy.table.Table`
264264
| tag : The species tag or molecular identifier.
265265
| molecule : An ASCII name for the species.

astroquery/mast/collections.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ def query_hsc_matchid_async(self, match, version=3, pagesize=None, page=None):
320320
one sepcific page of results.
321321
322322
Returns
323-
--------
323+
-------
324324
response : list of `~requests.Response`
325325
"""
326326

@@ -356,7 +356,7 @@ def get_hsc_spectra_async(self, pagesize=None, page=None):
356356
one sepcific page of results.
357357
358358
Returns
359-
--------
359+
-------
360360
response : list of `~requests.Response`
361361
"""
362362

@@ -387,7 +387,7 @@ def download_hsc_spectra(self, spectra, download_dir=None, cache=True, curl_flag
387387
will be downloaded that can be used to download the data files at a later time.
388388
389389
Returns
390-
--------
390+
-------
391391
response : list of `~requests.Response`
392392
"""
393393

astroquery/mast/observations.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ def list_missions(self):
7676
Lists data missions archived by MAST and avaiable through `astroquery.mast`.
7777
7878
Returns
79-
--------
79+
-------
8080
response : list
8181
List of available missions.
8282
"""
@@ -106,7 +106,7 @@ def get_metadata(self, query_type):
106106
The query to get metadata for. Options are observations, and products.
107107
108108
Returns
109-
--------
109+
-------
110110
response : `~astropy.table.Table`
111111
The metadata table.
112112
"""

astroquery/open_exoplanet_catalogue/oec_query.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ def get_catalogue(filepath=None):
1919
Parses the Open Exoplanet Catalogue file.
2020
2121
Parameters
22-
-----------
22+
----------
2323
filepath : str or None
2424
if no filepath is given, remote source is used.
2525

astroquery/vo_conesearch/validator/inspect.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ def print_cat(self, key, fout=None):
138138
If not found, nothing is written out.
139139
140140
Parameters
141-
-----------
141+
----------
142142
key : str
143143
Catalog key.
144144

0 commit comments

Comments
 (0)