climate-commits mailing list archives

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

- Update the data_source.local 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/fc6dde33
Tree: http://git-wip-us.apache.org/repos/asf/climate/tree/fc6dde33
Diff: http://git-wip-us.apache.org/repos/asf/climate/diff/fc6dde33

Branch: refs/heads/master
Commit: fc6dde333416976f906d8a448534565bd60cc052
Parents: c7e49f8
Author: Michael Joyce <joyce@apache.org>
Authored: Sun Jun 22 16:29:46 2014 -0700
Committer: Michael Joyce <joyce@apache.org>
Committed: Sun Jun 22 16:29:46 2014 -0700

----------------------------------------------------------------------
 ocw/data_source/local.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/climate/blob/fc6dde33/ocw/data_source/local.py
----------------------------------------------------------------------
diff --git a/ocw/data_source/local.py b/ocw/data_source/local.py
index 84a56a0..79e3ba8 100644
--- a/ocw/data_source/local.py
+++ b/ocw/data_source/local.py
@@ -201,8 +201,8 @@ def load_file(file_path, variable_name):
     :param variable_name: The given (by user) value variable name
     :type variable_name: String
 
-    :returns: A dataset object from dataset.py
-    :rtype: Object
+    :returns: An OCW Dataset object containing the requested parameter data.
+    :rtype: ocw.dataset.Dataset object
 
     :raises: ValueError
     '''


Mime
View raw message