Skip to content

Commit 5e8c097

Browse files
committed
DOC: fix sphinx build and cleanup init
1 parent 08b639f commit 5e8c097

File tree

2 files changed

+13
-25
lines changed

2 files changed

+13
-25
lines changed

astroquery/ipac/irsa/__init__.py

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
===============
55
66
This module contains various methods for querying the
7-
IRSA Catalog Query Service(CatQuery) and the Moving
8-
Object Search Tool (MOST).
7+
IRSA Services.
8+
99
"""
1010
from astropy import config as _config
1111

@@ -14,13 +14,6 @@ class Conf(_config.ConfigNamespace):
1414
"""
1515
Configuration parameters for `astroquery.ipac.irsa`.
1616
"""
17-
18-
irsa_server = _config.ConfigItem(
19-
'https://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query',
20-
'Name of the IRSA mirror to use.')
21-
gator_list_catalogs = _config.ConfigItem(
22-
'https://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-scan',
23-
'URL from which to list all the public catalogs in IRSA.')
2417
most_server = _config.ConfigItem(
2518
'https://irsa.ipac.caltech.edu/cgi-bin/MOST/nph-most',
2619
'URL address of the MOST service.')

astroquery/ipac/irsa/core.py

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
from astropy.coordinates import SkyCoord
1212
from astropy import units as u
1313
from astropy.utils.decorators import deprecated_renamed_argument
14-
from pyvo.dal.tap import TAPService
14+
from pyvo.dal import TAPService
1515
from astroquery import log
1616
from astroquery.query import BaseQuery
1717
from astroquery.utils.commons import parse_coordinates
@@ -37,7 +37,7 @@ def tap(self):
3737

3838
def query_tap(self, query, *, maxrec=None):
3939
"""
40-
Send query to IRSA TAP. Results in `~pyvo.dal.TapResult` format.
40+
Send query to IRSA TAP. Results in `~pyvo.dal.TAPResults` format.
4141
result.to_qtable in `~astropy.table.QTable` format
4242
4343
Parameters
@@ -47,9 +47,9 @@ def query_tap(self, query, *, maxrec=None):
4747
maxrec : int
4848
maximum number of records to return
4949
50-
Return
51-
------
52-
result : `~pyvo.dal.TapResult`
50+
Returns
51+
-------
52+
result : `~pyvo.dal.TAPResults`
5353
TAP query result.
5454
result.to_table : `~astropy.table.Table`
5555
TAP query result as `~astropy.table.Table`
@@ -66,23 +66,17 @@ def query_region(self, coordinates=None, *, catalog=None, spatial='Cone',
6666
get_query_payload=False, columns=None,
6767
verbose=False, cache=True):
6868
"""
69-
This function serves the same purpose as
70-
:meth:`~astroquery.ipac.irsa.IrsaClass.query_region`, but returns the raw
71-
HTTP response rather than the results in a `~astropy.table.Table`.
69+
Queries the IRSA TAP server around a coordinate and returns a `~astropy.table.Table` object.
7270
7371
Parameters
7472
----------
7573
coordinates : str, `astropy.coordinates` object
76-
Gives the position of the center of the cone or box if
77-
performing a cone or box search. The string can give coordinates
78-
in various coordinate systems, or the name of a source that will
79-
be resolved on the server (see `here
80-
<https://irsa.ipac.caltech.edu/search_help.html>`_ for more
81-
details). Required if spatial is ``'Cone'`` or ``'Box'``. Optional
82-
if spatial is ``'Polygon'`` or ``'All-Sky'``.
74+
Gives the position of the center of the cone or box if performing a cone or box search.
75+
Required if spatial is ``'Cone'`` or ``'Box'``. Ignored if spatial is ``'Polygon'`` or
76+
``'All-Sky'``.
8377
catalog : str
8478
The catalog to be used. To list the available catalogs, use
85-
:meth:`~astroquery.ipac.irsa.IrsaClass.print_catalogs`.
79+
:meth:`~astroquery.ipac.irsa.IrsaClass.list_catalogs`.
8680
spatial : str
8781
Type of spatial query: ``'Cone'``, ``'Box'``, ``'Polygon'``, and
8882
``'All-Sky'``. Defaults to ``'Cone'``.
@@ -107,6 +101,7 @@ def query_region(self, coordinates=None, *, catalog=None, spatial='Cone',
107101
108102
Returns
109103
-------
104+
table : A `~astropy.table.Table` object.
110105
"""
111106
if catalog is None:
112107
raise InvalidQueryError("Catalog name is required!")

0 commit comments

Comments
 (0)