Skip to content

Commit 8f330cf

Browse files
committed
Fix more docs for alfalfa
1 parent ad51f90 commit 8f330cf

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

docs/alfalfa/alfalfa.rst

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ This example shows how to perform an object cross-ID with ALFALFA. We'll start
1010
with the position of a source that exists in another survey (same object we
1111
used in the SDSS example).
1212

13-
.. code-block:: python
1413
.. doctest-remote-data::
1514

1615
>>> from astroquery.alfalfa import Alfalfa
1716
>>> from astropy import coordinates as coords
1817
>>> pos = coords.SkyCoord('0h8m05.63s +14d50m23.3s')
1918
>>> agc = Alfalfa.query_region(pos, optical_counterpart=True)
20-
19+
>>> agc
20+
100051
2121

2222
This retrieves the AGC number of the object closest to the supplied ra and dec
2323
(within search radius dr=3 arcminutes by default). The "optical_counterpart" keyword
@@ -27,19 +27,25 @@ determined by members of the ALFALFA team), rather than their radio centroids.
2727
The AGC number is an identification number for objects in the ALFALFA survey,
2828
and once we know it, we can download spectra (if they are available) easily,
2929

30-
.. code-block:: python
30+
.. Remove the skip once #2403 is fixed
31+
.. .. doctest-remote-data::
32+
.. doctest-skip::
3133

32-
>>> # sp = Alfalfa.get_spectrum(agc)
34+
>>> sp = Alfalfa.get_spectrum(agc)
3335

34-
This returns a PyFITS HDUList object. If we want to have a look at the entire ALFALFA catalog, we can do that too:
36+
This returns a `~astropy.io.fits.HDUList` object. If we want to have a look at the
37+
entire ALFALFA catalog as a dictionary, we can do that too:
3538

36-
.. code-block:: python
39+
.. doctest-remote-data::
3740

38-
>>> cat = Alfalfa.get_catalog() # doctest: +REMOTE_DATA
41+
>>> cat = Alfalfa.get_catalog()
42+
>>> cat.keys()
43+
dict_keys(['AGCNr', 'Name', 'RAdeg_HI', 'Decdeg_HI', 'RAdeg_OC', 'DECdeg_OC', 'Vhelio', 'W50', 'errW50', 'HIflux', 'errflux', 'SNR', 'RMS', 'Dist', 'logMsun', 'HIcode', 'OCcode', 'NoteFlag'])
3944

4045
which returns a dictionary containing HI measurements for nearly 16,000
4146
objects.
4247

48+
4349
Reference/API
4450
-------------
4551

0 commit comments

Comments
 (0)