Skip to content
This repository was archived by the owner on Oct 21, 2024. It is now read-only.

Commit b71d82b

Browse files
committed
Merge branch 'pat' of github.com:noaodatalab/sparclclient into pat
2 parents 92b3b7b + 4ebefbe commit b71d82b

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

api/client.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -312,29 +312,31 @@ def get_field_names(self, structure):
312312
return None
313313

314314
def orig_field(self, structure, client_name):
315-
"""Get original field name as provided in Data Release.
315+
"""Get original field name as provided in Data Set.
316316
317-
:param structure: Name of data set Structure
317+
:param structure: Name of Data Set
318318
:param client_name: Field name used in Client methods.
319319
:returns: Original field name
320320
:rtype: string
321321
322322
Example:
323323
>>> client.orig_field('BOSS-DR16', 'flux')
324+
'spectra.coadd.FLUX'
324325
325326
"""
326327
return self.new2origLUT[structure][client_name]
327328

328329
def client_field(self, structure, orig_name):
329330
"""Get field name used in Client methods
330331
331-
:param structure: Name of data set Structure
332-
:param orig_name: Original field name as provided in Data Release.
332+
:param structure: Name of Data Set
333+
:param orig_name: Original field name as provided in Data Set.
333334
:returns: Client field name
334335
:rtype: string
335336
336337
Example:
337-
>>> client.orig_field('BOSS-DR16', 'spectra.coadd.FLUX')
338+
>>> client.client_field('BOSS-DR16', 'spectra.coadd.FLUX')
339+
'flux'
338340
339341
"""
340342
return self.orig2newLUT[structure][orig_name]
@@ -472,7 +474,7 @@ def retrieve(self,
472474
List of paths to include in each record. (default: 'DEFAULT')
473475
rtype (str, optional): Data-type to use for spectra data. One of:
474476
json, numpy, pandas, spectrum1d. (default: None)
475-
structure (str): The data structure (DS) name associated with
477+
structure (str): The Data Set (DS) name associated with
476478
the specids. Or None to retrieve from any DS that contains the
477479
specid. (default: None)
478480
verbose (boolean, optional): (default: False)

0 commit comments

Comments
 (0)