CLIMATE-558 - Update RCMED module documentation links
Project: http://git-wip-us.apache.org/repos/asf/climate/repo Commit: http://git-wip-us.apache.org/repos/asf/climate/commit/95f09437 Tree: http://git-wip-us.apache.org/repos/asf/climate/tree/95f09437 Diff: http://git-wip-us.apache.org/repos/asf/climate/diff/95f09437 Branch: refs/heads/master Commit: 95f094374d992f019241f026c8855374429dbe05 Parents: e9b8ad8 Author: Michael Joyce <[email protected]> Authored: Mon Nov 17 12:50:48 2014 -0800 Committer: Michael Joyce <[email protected]> Committed: Mon Nov 17 12:50:48 2014 -0800 ---------------------------------------------------------------------- ocw/data_source/rcmed.py | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/climate/blob/95f09437/ocw/data_source/rcmed.py ---------------------------------------------------------------------- diff --git a/ocw/data_source/rcmed.py b/ocw/data_source/rcmed.py index 410bf48..669556e 100644 --- a/ocw/data_source/rcmed.py +++ b/ocw/data_source/rcmed.py @@ -37,7 +37,7 @@ def get_parameters_metadata(): '''Get the metadata of all parameter from RCMED. :returns: Dictionary of information for each parameter stored in one list - :rtype: List of dictionaries + :rtype: :class:`list` of :class:`dict` ''' param_info_list = [] @@ -316,24 +316,31 @@ def parameter_dataset(dataset_id, parameter_id, min_lat, max_lat, min_lon, max_l '''Get data from one database(parameter). :param dataset_id: Dataset id. - :type dataset_id: Integer + :type dataset_id: :class:`int` + :param parameter_id: Parameter id - :type parameter_id: Integer + :type parameter_id: :class:`int` + :param min_lat: Minimum latitude - :type min_lat: Float + :type min_lat: :class:`float` + :param max_lat: Maximum latitude - :type max_lat: Float + :type max_lat: :class:`float` + :param min_lon: Minimum longitude - :type min_lon: Float + :type min_lon: :class:`float` + :param max_lon: Maximum longitude - :type max_lon: Float + :type max_lon: :class:`float` + :param start_time: Start time - :type start_time: Datetime + :type start_time: :class:`datetime.datetime` + :param end_time: End time - :type end_time: Datetime + :type end_time: :class:`datetime.datetime` :returns: An OCW Dataset object contained the requested data from RCMED. - :rtype: ocw.dataset.Dataset object + :rtype: :class:`dataset.Dataset` ''' parameters_metadata = get_parameters_metadata()
