From 9cadfa16b917df9653a14e9abf676309daeed71c Mon Sep 17 00:00:00 2001 From: Michael James Date: Thu, 11 Oct 2018 15:16:53 -0600 Subject: [PATCH] docstring sphinx cleanup --- awips/dataaccess/DataAccessLayer.py | 10 +++++----- awips/dataaccess/SoundingsSupport.py | 6 ++++-- docs/source/conf.py | 1 - 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/awips/dataaccess/DataAccessLayer.py b/awips/dataaccess/DataAccessLayer.py index 1cff517..18e0fe6 100644 --- a/awips/dataaccess/DataAccessLayer.py +++ b/awips/dataaccess/DataAccessLayer.py @@ -154,7 +154,7 @@ def getAvailableTimes(request, refTimeOnly=False): Args: request: the IDataRequest to get data for refTimeOnly: optional, use True if only unique refTimes should be - returned (without a forecastHr) + returned (without a forecastHr) Returns: a list of DataTimes @@ -171,7 +171,7 @@ def getGridData(request, times=[]): Args: request: the IDataRequest to get data for times: a list of DataTimes, a TimeRange, or None if the data is time - agnostic + agnostic Returns: a list of IGridData @@ -188,10 +188,10 @@ def getGeometryData(request, times=[]): Args: request: the IDataRequest to get data for times: a list of DataTimes, a TimeRange, or None if the data is time - agnostic + agnostic Returns: - a list of IGeometryData + a list of IGeometryData """ return router.getGeometryData(request, times) @@ -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 diff --git a/awips/dataaccess/SoundingsSupport.py b/awips/dataaccess/SoundingsSupport.py index f5e4ab8..d9ee4b8 100644 --- a/awips/dataaccess/SoundingsSupport.py +++ b/awips/dataaccess/SoundingsSupport.py @@ -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 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. + 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. + If not specified, will default to all forecast hours. Returns: 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) = \ diff --git a/docs/source/conf.py b/docs/source/conf.py index a685f96..706b244 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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),