cleanup readthedoc build warnings

This commit is contained in:
Michael James 2018-10-11 14:56:26 -06:00
parent c056251634
commit ecaa7f4515
3 changed files with 23 additions and 46 deletions

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,7 +188,7 @@ 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

View file

@ -30,19 +30,19 @@ def getSounding(modelName, weatherElements, levels, samplePoint, refTime=None, t
based on the specified request parameters. based on the specified request parameters.
Args: Args:
modelName: the grid model datasetid to use as the basis of the sounding. modelName: the grid model datasetid to use as the basis of the sounding.
weatherElements: a list of parameters to return in the sounding. weatherElements: a list of parameters to return in the sounding.
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) = \

File diff suppressed because one or more lines are too long