Skip to content

Commit

Permalink
Merge pull request #2937 from esdc-esac-esa-int/ESA_gaia_update_docst…
Browse files Browse the repository at this point in the history
…ring

GAIA: Update the information for the returned value in the docstring of the function cross_match.
  • Loading branch information
bsipocz authored Jan 30, 2024
2 parents 8efac7b + b4c1492 commit b39ef34
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions astroquery/gaia/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -420,6 +420,7 @@ def get_datalinks(self, ids, *, linking_parameter='SOURCE_ID', verbose=False):
-- Gaia.get_datalinks(ids=(1104405489608579584, 1809140662896080256)) # multiple ids as an int list
-- Gaia.get_datalinks(ids=('1104405489608579584','1809140662896080256')) # multiple ids as str list
-- Gaia.get_datalinks(ids='4295806720-38655544960') # range of ids as a str
-- Gaia.get_datalinks(ids='4295806720-38655544960, 549755818112-1275606125952') # multiple ranges of ids as
Expand All @@ -429,6 +430,7 @@ def get_datalinks(self, ids, *, linking_parameter='SOURCE_ID', verbose=False):
as a str list
-- Gaia.get_datalinks(ids='Gaia DR3 1104405489608579584') # single designator
-- Gaia.get_datalinks(ids='Gaia DR3 1104405489608579584, Gaia DR3 1809140662896080256') # multiple
designators as a str
Expand All @@ -444,10 +446,10 @@ def get_datalinks(self, ids, *, linking_parameter='SOURCE_ID', verbose=False):
1275606125952')) # multiple ranges of designators as a str list
-- Gaia.get_datalinks(ids='Gaia DR3 4295806720-Gaia DR3 38655544960, Gaia DR2 549755818112-Gaia DR2
1275606125952') # multiple ranges of designators with difference releases as a str
1275606125952') # multiple ranges of designators with different releases as a str
-- Gaia.get_datalinks(ids=('Gaia DR3 4295806720-Gaia DR3 38655544960', 'Gaia DR2 549755818112-Gaia DR2
1275606125952')) # multiple ranges of designators with difference releases as a str list
1275606125952')) # multiple ranges of designators with different releases as a str list
"""

if linking_parameter not in self.VALID_LINKING_PARAMETERS:
Expand Down Expand Up @@ -897,7 +899,7 @@ def cross_match(self, *, full_qualified_table_name_a,
Returns
-------
Boolean indicating if the specified user is valid
A Job object
"""
if radius < 0.1 or radius > 10.0:
raise ValueError(f"Invalid radius value. Found {radius}, valid range is: 0.1 to 10.0")
Expand Down

0 comments on commit b39ef34

Please sign in to comment.