docstring sphinx cleanup

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

View file

@ -295,7 +295,7 @@ def newDataRequest(datatype=None, **kwargs):
levels: a list of levels to set on the request
locationNames: a list of locationNames to set on 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:
a new IDataRequest

View file

@ -36,6 +36,7 @@ def getSounding(modelName, weatherElements, levels, samplePoint, refTime=None, t
samplePoint: a lat/lon pair to perform the sampling of data at.
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.
timeRange: (optional) a TimeRange to specify which forecast hours to use.
If not specified, will default to all forecast hours.
@ -43,6 +44,7 @@ def getSounding(modelName, weatherElements, levels, samplePoint, refTime=None, t
A _SoundingCube instance, which acts a 3-tiered dictionary, keyed
by DataTime, then by level and finally by weather element. If no
data is available for the given request parameters, None is returned.
"""
(locationNames, parameters, levels, envelope, refTime, timeRange) = \

View file

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