add documentation for simbad typed_id; closes
@@ -621,8 +621,9 @@ To set additional fields to be returned in the VOTable:
['main_id', 'coordinates', 'mk', 'rot', 'bibcodelist(1800-2014')]
-You can also remove a field you have set or :meth:`astroquery.simbad.SimbadClass.reset_votable_fields`.
-Continuing from the above example:
+You can also remove a field you have set or
+:meth:`astroquery.simbad.SimbadClass.reset_votable_fields`. Continuing from
+the above example:
.. code-block:: python
@@ -638,6 +639,24 @@ Continuing from the above example:
['main_id', 'coordinates']
+
+Returning the queried name in the return table
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+You can include the name(s) queried in the output table by adding `typed_id` to
+the votable fields.
+
+ >>> Simbad.add_votable_fields('typed_id')
+ >>> Simbad.query_objects(['M31', 'Eta Carinae', 'Alpha Centauri'])
+
+ <Table masked=True length=3>
+ MAIN_ID RA DEC RA_PREC DEC_PREC COO_ERR_MAJA COO_ERR_MINA COO_ERR_ANGLE COO_QUAL COO_WAVELENGTH COO_BIBCODE TYPED_ID
+ "h:m:s" "d:m:s" mas mas deg
+ object str13 str13 int16 int16 float32 float32 int16 str1 str1 object object
+ --------- ------------- ------------- ------- -------- ------------ ------------ ------------- -------- -------------- ------------------- --------------
+ M 31 00 42 44.330 +41 16 07.50 7 7 -- -- 0 C I 2006AJ....131.1163S M31
+ + eta Car 10 45 03.5455 -59 41 03.951 11 11 11.000 10.000 90 B O 2000A&A...355L..27H Eta Carinae
+ + alf Cen 14 39 29.7199 -60 49 55.999 9 9 -- -- 0 C O 2016A&A...589A.115S Alpha Centauri
+
Specifying the format of the included VOTable fields
----------------------------------------------------
