Skip to content

Commit ff414cb

Browse files
keflavichbsipocz
authored andcommitted
clean some documentation language
1 parent 698ae17 commit ff414cb

File tree

2 files changed

+16
-9
lines changed

2 files changed

+16
-9
lines changed

docs/index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,8 +201,10 @@ The following modules have been completed using a common API:
201201
vamdc/vamdc.rst
202202
vizier/vizier.rst
203203
vo_conesearch/vo_conesearch.rst
204+
vsa/vsa.rst
204205
xmatch/xmatch.rst
205206

207+
206208
These others are functional, but do not follow a common & consistent API:
207209

208210
.. toctree::
@@ -222,6 +224,13 @@ These others are functional, but do not follow a common & consistent API:
222224
sdss/sdss.rst
223225
sha/sha.rst
224226

227+
There are also subpackages that serve as the basis of others.
228+
229+
.. toctree::
230+
:maxdepth: 1
231+
232+
wfau/wfau.rst
233+
225234
Catalog, Archive, and Other
226235
===========================
227236

@@ -251,6 +260,7 @@ for each source)
251260
sha/sha.rst
252261
simbad/simbad.rst
253262
ukidss/ukidss.rst
263+
vsa/vsa.rst
254264
vizier/vizier.rst
255265
xmatch/xmatch.rst
256266
vo_conesearch/vo_conesearch.rst
@@ -282,6 +292,7 @@ generally return a table listing the available data first.
282292
sdss/sdss.rst
283293
sha/sha.rst
284294
ukidss/ukidss.rst
295+
vsa/vsa.rst
285296
skyview/skyview.rst
286297

287298
Simulations

docs/ukidss/ukidss.rst

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,14 @@ This module allows searching catalogs and retrieving images from the UKIDSS web
1313
service. Some data can on UKIDSS can be accessed only after a valid login. For
1414
accessing such data a UKIDSS object must first be instantiated with valid
1515
credentials. On the other hand, to access the public data, the various query
16-
functions may just be called as class methods - i.e. no instantiation is
17-
required. Below are examples that illustrate both the means for accessing the
18-
data.
16+
functions may just be called without logging in. Below are examples that
17+
illustrate both the means for accessing the data.
1918

2019
**Case 1 : Access only public data - No login**
2120

2221
.. code-block:: python
2322
2423
>>> from astroquery.ukidss import Ukidss
25-
26-
# perform any query as a class method - no instantiation required
27-
2824
>>> images = Ukidss.get_images("m1")
2925
3026
Found 1 targets
@@ -38,7 +34,7 @@ data.
3834
3935
>>> from astroquery.ukidss import Ukidss
4036
41-
# Now first instantiate a Ukidss object with login credentials
37+
# Now first instantiate a new Ukidss object with login credentials
4238
4339
>>> u_obj = Ukidss(username='xyz', password='secret', # doctest: +SKIP
4440
... community='your_community') # doctest: +SKIP
@@ -48,8 +44,8 @@ data.
4844
4945
Note that at login time you may also optionally set the database and the survey
5046
that you would like to query. By default the database is set to 'UKIDSSDR7PLUS'
51-
and the ``programme_id`` is set to 'all' - which includes all the surveys. A word
52-
of warning - for region queries you should explicitly set the
47+
and the ``programme_id`` is set to 'all' - which includes all the surveys. A
48+
word of warning - for region queries you should explicitly set the
5349
``programme_id`` to the survey you wish to query. Querying all surveys is
5450
permitted only for image queries.
5551

0 commit comments

Comments
 (0)