Skip to content

Commit 6594ebb

Browse files
committed
DOC: minor changelog rephrase and reformat
1 parent 86ed0d7 commit 6594ebb

File tree

1 file changed

+30
-28
lines changed

1 file changed

+30
-28
lines changed

CHANGES.rst

+30-28
Original file line numberDiff line numberDiff line change
@@ -45,46 +45,48 @@ vizier
4545
simbad
4646
^^^^^^
4747

48-
- The ``ROW_LIMIT`` value to have the maximum number of rows is now -1. ``ROW_LIMIT = 0`` now
49-
allows to retrieve an empty table with the output's meta-data [#2954]
48+
- The ``ROW_LIMIT`` value to have the maximum number of rows is now -1.
49+
Use ``ROW_LIMIT = 0`` to retrieve the output's meta-data. [#2954]
5050

51-
- ``ROW_LIMIT`` can now be set at instantiation (ex: ``simbad = Simbad(ROW_LIMIT=10))``) [#2954]
51+
- ``ROW_LIMIT`` can now be set at instantiation
52+
(e.g.: ``simbad = Simbad(ROW_LIMIT=10))``). [#2954]
5253

53-
- ``list_votable_fields`` now return an astropy Table with added fields information instead
54-
of a list of strings [#2954]
54+
- ``list_votable_fields`` now return an astropy Table with added fields
55+
information instead of a list of strings. [#2954]
5556

56-
- ``list_votable_fields`` is now queried directly from SIMBAD instead of reading a file
57-
in astroquery. This prevents it from being outdated [#2954]
57+
- ``list_votable_fields`` is now queried directly from SIMBAD instead of reading
58+
a file in astroquery. This prevents it from being outdated. [#2954]
5859

59-
- ``get_votable_fields`` now prints the table name and column name instead of just the
60-
column name [#2954]
60+
- ``get_votable_fields`` now prints the table name and column name instead of
61+
just the column name. [#2954]
6162

62-
- The ``verbose`` and ``cache`` arguments are removed from all methods as they don't work
63-
with the new query interface [#2954]
63+
- The ``verbose`` and ``cache`` kwargs have been deprecated from all methods
64+
as they have no effect with with the new query interface. [#2954]
6465

65-
- ``get_adql`` is replaced by ``get_query_payload`` in ``list_columns`` and ``list_table``.
66-
The payload output contains the ADQL under the ``QUERY`` key [#2954]
66+
- ``get_adql`` is deprecated and replaced by ``get_query_payload`` in
67+
``list_columns`` and ``list_table``.
68+
The payload output contains the ADQL under the ``QUERY`` key. [#2954]
6769

68-
- all query methods except ``query_tap`` and ``query_criteria`` now accept a ``criteria``
69-
argument to restrict the results with custom criteria [#2954]
70+
- all query methods except ``query_tap`` and ``query_criteria`` now accept a
71+
``criteria`` argument to restrict the results with custom criteria. [#2954]
7072

71-
- ``query_objects`` outputs now have an additional column ``user_specified_id`` that contains
72-
the requested object's name as typed within astroquery. The ``votable_field`` option
73-
``typed_id`` is removed [#2954]
73+
- ``query_objects`` outputs now have an additional column ``user_specified_id``
74+
containing the objects' name as specified by the user.
75+
The ``votable_field`` option ``typed_id`` is removed. [#2954]
7476

75-
- ``query_region`` does not accept ``equinox`` and ``epoch`` anymore, as this functionality
76-
is handled by the astropy coordinates SkyCoord object [#2954]
77+
- The ``equinox`` and ``epoch`` kwargs are deprecated in ``query_region``,
78+
use astropy.coordinates.SkyCoord directly instead. [#2954]
7779

78-
- ``query_bibcode`` has a new option ``abstract`` that allows to also retrieve the
79-
article's abstract [#2954]
80+
- ``query_bibcode`` has a new option ``abstract`` that allows to also
81+
retrieve the article's abstract. [#2954]
8082

81-
- ``query_bibcode`` output is now in an astropy table with distinct columns instead of a single
82-
one in which all the information was a string [#2954]
83+
- ``query_bibcode`` output is now in an astropy Table with distinct columns
84+
instead of a single one in which all the information was a string. [#2954]
8385

84-
- ``query_criteria`` is now deprecated and should be replaced by either custom TAP queries
85-
of the ``criteria`` argument added in the other query methods. A helper method was added
86-
``astroquery.simbad.utils.CriteriaTranslator`` to translate automatically between the sim-script
87-
syntax and the TAP/ADQL syntax [#2954]
86+
- ``query_criteria`` is now deprecated and should be replaced by either custom
87+
TAP queries or by the ``criteria`` argument added in the other query methods.
88+
A helper method was added ``astroquery.simbad.utils.CriteriaTranslator`` to
89+
translate between the sim-script syntax and the TAP/ADQL syntax. [#2954]
8890

8991
skyview
9092
^^^^^^^

0 commit comments

Comments
 (0)