climate-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jo...@apache.org
Subject [3/6] git commit: Update data_source.rcmed function parameter documentation
Date Sun, 29 Jun 2014 04:44:35 GMT
Update data_source.rcmed function parameter documentation

- Update the data_source.rcmed function documentation so the references to
  ocw.dataset.Dataset objects are in a consistent form. In the future,
  these should be updated to properly reference the Dataset object's
  documentation (if possible).


Project: http://git-wip-us.apache.org/repos/asf/climate/repo
Commit: http://git-wip-us.apache.org/repos/asf/climate/commit/c26e8c51
Tree: http://git-wip-us.apache.org/repos/asf/climate/tree/c26e8c51
Diff: http://git-wip-us.apache.org/repos/asf/climate/diff/c26e8c51

Branch: refs/heads/master
Commit: c26e8c518fcad5cd63ce0cb8805245b800913180
Parents: fc6dde3
Author: Michael Joyce <joyce@apache.org>
Authored: Sun Jun 22 16:32:47 2014 -0700
Committer: Michael Joyce <joyce@apache.org>
Committed: Sun Jun 22 16:32:47 2014 -0700

----------------------------------------------------------------------
 ocw/data_source/rcmed.py | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/climate/blob/c26e8c51/ocw/data_source/rcmed.py
----------------------------------------------------------------------
diff --git a/ocw/data_source/rcmed.py b/ocw/data_source/rcmed.py
index 3b86c9b..410bf48 100644
--- a/ocw/data_source/rcmed.py
+++ b/ocw/data_source/rcmed.py
@@ -332,8 +332,8 @@ def parameter_dataset(dataset_id, parameter_id, min_lat, max_lat, min_lon,
max_l
     :param end_time: End time 
     :type end_time: Datetime
 
-    :returns: Dataset object
-    :rtype: Object
+    :returns: An OCW Dataset object contained the requested data from RCMED.
+    :rtype: ocw.dataset.Dataset object
     '''
     
     parameters_metadata = get_parameters_metadata()
@@ -346,4 +346,4 @@ def parameter_dataset(dataset_id, parameter_id, min_lat, max_lat, min_lon,
max_l
     values = _reshape_values(values, unique_lats_lons_times)
     values = _make_mask_array(values, parameter_id, parameters_metadata)
     
-    return Dataset(unique_lats_lons_times[0], unique_lats_lons_times[1], unique_times, values,
parameter_name)
\ No newline at end of file
+    return Dataset(unique_lats_lons_times[0], unique_lats_lons_times[1], unique_times, values,
parameter_name)


Mime
View raw message