Skip to content

Commit 1111158

Browse files
committed
Add google style doc
1 parent 682b1c9 commit 1111158

1 file changed

Lines changed: 29 additions & 9 deletions

File tree

odm2api/ODM2/services/readService.py

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -363,15 +363,35 @@ def getProcessingLevels(self, ids=None, codes=None):
363363
"""
364364

365365
def getSamplingFeatures(self, ids=None, codes=None, uuids=None, type=None, wkt=None, results=False):
366-
"""
367-
getSamplingFeatures(self, ids=None, codes=None, uuids=None, type=None, wkt=None, results=False):
368-
* Pass nothing - returns a list of all sampling feature objects with each object of type specific to that sampling feature
369-
* Pass a list of SamplingFeatureID - returns a single sampling feature object for the given ids
370-
* Pass a list of SamplingFeatureCode - returns a single sampling feature object for the given code
371-
* Pass a list of SamplingFeatureUUID - returns a single sampling feature object for the given UUID's
372-
* Pass a SamplingFeatureType - returns a list of sampling feature objects of the type passed in
373-
* Pass a SamplingFeature Well Known Text - return a list of sampling feature objects
374-
* Pass whether or not you want to return only the sampling features that have results associated with them
366+
"""Retrieve a list of Sampling Feature objects.
367+
368+
If no arguments are passed to the function, or their values are None,
369+
all Sampling Feature objects in the database will be returned.
370+
371+
Args:
372+
ids (list, optional): List of SamplingFeatureIDs.
373+
codes (list, optional): List of SamplingFeature Codes.
374+
uuids (list, optional): List of UUIDs string.
375+
type (str, optional): Type of Sampling Feature from
376+
`controlled vocabulary name <http://vocabulary.odm2.org/samplingfeaturetype/>`_.
377+
wkt (str, optional): SamplingFeature Well Known Text.
378+
results (bool, optional): Whether or not you want to return only the
379+
sampling features that have results associated with them.
380+
381+
Returns:
382+
list: List of Sampling Feature objects
383+
384+
Examples:
385+
>>> READ = ReadODM2(SESSION_FACTORY)
386+
>>> READ.getSamplingFeatures(ids=[39, 40])
387+
>>> READ.getSamplingFeatures(codes=['HOME', 'FIELD'])
388+
>>> READ.getSamplingFeatures(uuids=['a6f114f1-5416-4606-ae10-23be32dbc202',
389+
... '5396fdf3-ceb3-46b6-aaf9-454a37278bb4'])
390+
>>> READ.getSamplingFeatures(type='Site')
391+
>>> READ.getSamplingFeatures(wkt='POINT (30 10)')
392+
>>> READ.getSamplingFeatures(results=True)
393+
>>> READ.getSamplingFeatures(type='Site', results=True)
394+
375395
"""
376396
if results:
377397
try:

0 commit comments

Comments
 (0)