Skip to content

Commit

Permalink
DOC: minor changelog rephrase and reformat
Browse files Browse the repository at this point in the history
  • Loading branch information
bsipocz committed Jun 20, 2024
1 parent 86ed0d7 commit 6594ebb
Showing 1 changed file with 30 additions and 28 deletions.
58 changes: 30 additions & 28 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,46 +45,48 @@ vizier
simbad
^^^^^^

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

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

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

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

- ``get_votable_fields`` now prints the table name and column name instead of just the
column name [#2954]
- ``get_votable_fields`` now prints the table name and column name instead of
just the column name. [#2954]

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

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

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

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

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

- ``query_bibcode`` has a new option ``abstract`` that allows to also retrieve the
article's abstract [#2954]
- ``query_bibcode`` has a new option ``abstract`` that allows to also
retrieve the article's abstract. [#2954]

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

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

skyview
^^^^^^^
Expand Down

0 comments on commit 6594ebb

Please sign in to comment.