xan/python-awips
1
0
Fork 0
mirror of https://github.com/Unidata/python-awips.git synced 2025-02-23 22:57:56 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docstring sphinx cleanup

Browse source
This commit is contained in:
Michael James 2018-10-11 15:16:53 -06:00
parent ecaa7f4515
commit 9cadfa16b9
3 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
awips/dataaccess/DataAccessLayer.py
View file

@ -154,7 +154,7 @@ def getAvailableTimes(request, refTimeOnly=False):
Args: Args:
request: the IDataRequest to get data for request: the IDataRequest to get data for
refTimeOnly: optional, use True if only unique refTimes should be refTimeOnly: optional, use True if only unique refTimes should be
returned (without a forecastHr) returned (without a forecastHr)
Returns: Returns:
a list of DataTimes a list of DataTimes
@ -171,7 +171,7 @@ def getGridData(request, times=[]):
Args: Args:
request: the IDataRequest to get data for request: the IDataRequest to get data for
times: a list of DataTimes, a TimeRange, or None if the data is time times: a list of DataTimes, a TimeRange, or None if the data is time
agnostic agnostic
Returns: Returns:
a list of IGridData a list of IGridData
@ -188,10 +188,10 @@ def getGeometryData(request, times=[]):
Args: Args:
request: the IDataRequest to get data for request: the IDataRequest to get data for
times: a list of DataTimes, a TimeRange, or None if the data is time times: a list of DataTimes, a TimeRange, or None if the data is time
agnostic agnostic
Returns: Returns:
a list of IGeometryData a list of IGeometryData
""" """
return router.getGeometryData(request, times) return router.getGeometryData(request, times)
@ -295,7 +295,7 @@ def newDataRequest(datatype=None, **kwargs):
levels: a list of levels to set on the request levels: a list of levels to set on the request
locationNames: a list of locationNames to set on the request locationNames: a list of locationNames to set on the request
envelope: an envelope to limit the request envelope: an envelope to limit the request
**kwargs: any leftover kwargs will be set as identifiers kwargs: any leftover kwargs will be set as identifiers
Returns: Returns:
a new IDataRequest a new IDataRequest

6
awips/dataaccess/SoundingsSupport.py
View file

@ -35,14 +35,16 @@ def getSounding(modelName, weatherElements, levels, samplePoint, refTime=None, t
levels: a list of levels to sample the given weather elements at levels: a list of levels to sample the given weather elements at
samplePoint: a lat/lon pair to perform the sampling of data at. samplePoint: a lat/lon pair to perform the sampling of data at.
refTime: (optional) the grid model reference time to use for the sounding. refTime: (optional) the grid model reference time to use for the sounding.
If not specified, the latest ref time in the system will be used. If not specified, the latest ref time in the system will be used.
timeRange: (optional) a TimeRange to specify which forecast hours to use. timeRange: (optional) a TimeRange to specify which forecast hours to use.
If not specified, will default to all forecast hours. If not specified, will default to all forecast hours.
Returns: Returns:
A _SoundingCube instance, which acts a 3-tiered dictionary, keyed A _SoundingCube instance, which acts a 3-tiered dictionary, keyed
by DataTime, then by level and finally by weather element. If no by DataTime, then by level and finally by weather element. If no
data is available for the given request parameters, None is returned. data is available for the given request parameters, None is returned.
""" """
(locationNames, parameters, levels, envelope, refTime, timeRange) = \ (locationNames, parameters, levels, envelope, refTime, timeRange) = \

1
docs/source/conf.py
View file

@ -296,7 +296,6 @@ texinfo_documents = [
# Set up mapping for other projects' docs # Set up mapping for other projects' docs
intersphinx_mapping = { intersphinx_mapping = {
'matplotlib': ('http://matplotlib.org/', None), 'matplotlib': ('http://matplotlib.org/', None),
'metpy': ('https://unidata.github.io/MetPy/', None),
'numpy': ('http://docs.scipy.org/doc/numpy/', None), 'numpy': ('http://docs.scipy.org/doc/numpy/', None),
'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None), 'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
'pint': ('http://pint.readthedocs.org/en/stable/', None), 'pint': ('http://pint.readthedocs.org/en/stable/', None),