climate-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jo...@apache.org
Subject [17/21] climate git commit: CLIMATE-558 - Update ESGF module documentation links
Date Wed, 19 Nov 2014 16:53:32 GMT
CLIMATE-558 - Update ESGF 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/ff85d6f1
Tree: http://git-wip-us.apache.org/repos/asf/climate/tree/ff85d6f1
Diff: http://git-wip-us.apache.org/repos/asf/climate/diff/ff85d6f1

Branch: refs/heads/master
Commit: ff85d6f10c61f3fe8bb69e2b3d1c992f7924d59c
Parents: 016bd67
Author: Michael Joyce <joyce@apache.org>
Authored: Mon Nov 17 12:50:22 2014 -0800
Committer: Michael Joyce <joyce@apache.org>
Committed: Mon Nov 17 12:50:22 2014 -0800

----------------------------------------------------------------------
 ocw/data_source/esgf.py | 23 +++++++++++++++--------
 1 file changed, 15 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/climate/blob/ff85d6f1/ocw/data_source/esgf.py
----------------------------------------------------------------------
diff --git a/ocw/data_source/esgf.py b/ocw/data_source/esgf.py
index 084a73d..1e8038d 100644
--- a/ocw/data_source/esgf.py
+++ b/ocw/data_source/esgf.py
@@ -38,25 +38,32 @@ def load_dataset(dataset_id,
     ''' Load an ESGF dataset.
 
     :param dataset_id: The ESGF ID of the dataset to load.
-    :type dataset_id: String
+    :type dataset_id: :mod:`string`
+
     :param variable: The variable to load.
-    :type variable: String
+    :type variable: :mod:`string`
+
     :param esgf_username: ESGF OpenID value to use for authentication.
-    :type esgf_username: String
+    :type esgf_username: :mod:`string`
+
     :param esgf_password: ESGF Password to use for authentication.
-    :type esgf_password: String
+    :type esgf_password: :mod:`string`
+
     :param search_url: (Optional) The ESGF node to use for searching. Defaults
         to the Jet Propulsion Laboratory node.
-    :type search_url: String
+    :type search_url: :mod:`string`
+
     :param elevation_index: (Optional) The elevation level to strip out when
         loading the dataset using ocw.data_source.local.
+    :type elevation_index: :class:`int`
+
     :param additional_constraints: (Optional) Additional key,value pairs to
         pass as constraints to the search wrapper. These can be anything found
         on the ESGF metadata page for a dataset.
 
-    :returns: A list of ocw.dataset.Dataset objects contained the requested
-        dataset. If the dataset is stored in multiple files each will be loaded
-        into a separate ocw.dataset.Dataset object.
+    :returns: A :class:`list` of :class:`dataset.Dataset` contained the
+        requested dataset. If the dataset is stored in multiple files each will
+        be loaded into a separate :class:`dataset.Dataset`.
 
     :raises ValueError: If no dataset can be found for the supplied ID and
         variable, or if the requested dataset is a multi-file dataset.


Mime
View raw message