Skip to content

Commit 90ab03e

Browse files
weaverba137weaverba137
committed
restore position of Return sections
1 parent 601280f commit 90ab03e

File tree

1 file changed

+48
-41
lines changed

1 file changed

+48
-41
lines changed

‎astroquery/sdss/core.py

Lines changed: 48 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -126,18 +126,19 @@ def query_crossid_async(self, coordinates, *, radius=5. * u.arcsec, timeout=TIME
126126
cache : bool, optional
127127
If ``True`` use the request caching mechanism.
128128
129-
Returns
130-
-------
131-
result : `~astropy.table.Table`
132-
The result of the query as a `~astropy.table.Table` object.
133-
134129
Raises
135130
------
136131
TypeError
137132
If the `radius` keyword could not be parsed as an angle.
138133
ValueError
139134
If the `radius` exceeds 3 arcmin, or if the sizes of
140135
`coordinates` and `obj_names` do not match.
136+
137+
Returns
138+
-------
139+
result : `~astropy.table.Table`
140+
The result of the query as a `~astropy.table.Table` object.
141+
141142
"""
142143

143144
if isinstance(radius, Angle):
@@ -285,11 +286,6 @@ def query_region_async(self, coordinates, *, radius=None,
285286
cache : bool, optional
286287
If ``True`` use the request caching mechanism.
287288
288-
Returns
289-
-------
290-
result : `~astropy.table.Table`
291-
The result of the query as a `~astropy.table.Table` object.
292-
293289
Raises
294290
------
295291
TypeError
@@ -313,6 +309,12 @@ def query_region_async(self, coordinates, *, radius=None,
313309
2.02344596595 14.8398237229 1237652943176138867 1739 301 3 315
314310
2.02344596303 14.8398237521 1237652943176138868 1739 301 3 315
315311
2.02344772021 14.8398201105 1237653651835781243 1904 301 3 163
312+
313+
Returns
314+
-------
315+
result : `~astropy.table.Table`
316+
The result of the query as a `~astropy.table.Table` object.
317+
316318
"""
317319
# Allow field_help requests to pass without requiring a radius or width.
318320
if field_help and radius is None and width is None:
@@ -445,11 +447,6 @@ def query_specobj_async(self, *, plate=None, mjd=None, fiberID=None,
445447
cache : bool, optional
446448
If ``True`` use the request caching mechanism.
447449
448-
Returns
449-
-------
450-
result : `~astropy.table.Table`
451-
The result of the query as an `~astropy.table.Table` object.
452-
453450
Examples
454451
--------
455452
>>> from astroquery.sdss import SDSS
@@ -463,6 +460,12 @@ def query_specobj_async(self, *, plate=None, mjd=None, fiberID=None,
463460
47.1604269095 5.48241410994 2340 53733 332 2634697104106219520
464461
48.6634992214 6.69459110287 2340 53733 553 2634757852123654144
465462
48.0759195428 6.18757403485 2340 53733 506 2634744932862027776
463+
464+
Returns
465+
-------
466+
result : `~astropy.table.Table`
467+
The result of the query as an `~astropy.table.Table` object.
468+
466469
"""
467470

468471
if plate is None and mjd is None and fiberID is None:
@@ -524,11 +527,6 @@ def query_photoobj_async(self, *, run=None, rerun=301, camcol=None,
524527
cache : bool, optional
525528
If ``True`` use the request caching mechanism.
526529
527-
Returns
528-
-------
529-
result : `~astropy.table.Table`
530-
The result of the query as a `~astropy.table.Table` object.
531-
532530
Examples
533531
--------
534532
>>> from astroquery.sdss import SDSS
@@ -541,6 +539,12 @@ def query_photoobj_async(self, *, run=None, rerun=301, camcol=None,
541539
22.2574304026 8.43175488904 1237670017262485671 5714 301 6 21
542540
23.3724928784 8.32576993103 1237670017262944491 5714 301 6 28
543541
25.4801226435 8.27642390025 1237670017263927330 5714 301 6 43
542+
543+
Returns
544+
-------
545+
result : `~astropy.table.Table`
546+
The result of the query as a `~astropy.table.Table` object.
547+
544548
"""
545549

546550
if run is None and camcol is None and field is None:
@@ -585,11 +589,6 @@ def query_sql_async(self, sql_query, *, timeout=TIMEOUT,
585589
cache : bool, optional
586590
If ``True`` use the request caching mechanism.
587591
588-
Returns
589-
-------
590-
result : `~astropy.table.Table`
591-
The result of the query as a `~astropy.table.Table` object.
592-
593592
Examples
594593
--------
595594
>>> from astroquery.sdss import SDSS
@@ -610,6 +609,13 @@ class = 'galaxy' \
610609
0.3000027 156.25024 7.6586271 1237658425162858683
611610
0.3000027 256.99461 25.566255 1237661387086693265
612611
0.300003 175.65125 34.37548 1237665128003731630
612+
613+
614+
Returns
615+
-------
616+
result : `~astropy.table.Table`
617+
The result of the query as a `~astropy.table.Table` object.
618+
613619
"""
614620

615621
request_payload = dict(cmd=self.__sanitize_query(sql_query),
@@ -677,14 +683,6 @@ def get_spectra_async(self, *, coordinates=None, radius=2. * u.arcsec,
677683
show_progress : bool, optional
678684
If False, do not display download progress.
679685
680-
Returns
681-
-------
682-
list : list
683-
A list of context-managers that yield readable file-like objects.
684-
The function returns the spectra for only one of ``matches``, or
685-
``coordinates`` and ``radius``, or ``plate``, ``mjd`` and
686-
``fiberID``.
687-
688686
Examples
689687
--------
690688
Using results from a call to `query_region`:
@@ -703,6 +701,14 @@ def get_spectra_async(self, *, coordinates=None, radius=2. * u.arcsec,
703701
704702
>>> specs = SDSS.get_spectra(plate=751, mjd=52251)
705703
704+
Returns
705+
-------
706+
list : list
707+
A list of context-managers that yield readable file-like objects.
708+
The function returns the spectra for only one of ``matches``, or
709+
``coordinates`` and ``radius``, or ``plate``, ``mjd`` and
710+
``fiberID``.
711+
706712
"""
707713

708714
if not matches:
@@ -846,10 +852,6 @@ def get_images_async(self, coordinates=None, radius=2. * u.arcsec,
846852
show_progress : bool, optional
847853
If False, do not display download progress.
848854
849-
Returns
850-
-------
851-
list : List of `~astropy.io.fits.HDUList` objects.
852-
853855
Examples
854856
--------
855857
Using results from a call to `query_region`:
@@ -872,6 +874,10 @@ def get_images_async(self, coordinates=None, radius=2. * u.arcsec,
872874
873875
>>> imgs = SDSS.get_images(run=1904, camcol=3, field=164)
874876
877+
Returns
878+
-------
879+
list : List of `~astropy.io.fits.HDUList` objects.
880+
875881
"""
876882
if not matches:
877883
if coordinates is None:
@@ -977,15 +983,16 @@ def get_spectral_template_async(self, kind='qso', *, timeout=TIMEOUT,
977983
show_progress : bool, optional
978984
If False, do not display download progress.
979985
980-
Returns
981-
-------
982-
list : List of `~astropy.io.fits.HDUList` objects.
983-
984986
Examples
985987
--------
986988
>>> qso = SDSS.get_spectral_template(kind='qso')
987989
>>> Astar = SDSS.get_spectral_template(kind='star_A')
988990
>>> Fstar = SDSS.get_spectral_template(kind='star_F')
991+
992+
Returns
993+
-------
994+
list : List of `~astropy.io.fits.HDUList` objects.
995+
989996
"""
990997

991998
if kind == 'all':

0 commit comments

Comments
 (0)