climate-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From good...@apache.org
Subject svn commit: r1506691 - /incubator/climate/branches/RefactorInput/ocw/plotter.py
Date Wed, 24 Jul 2013 20:16:51 GMT
Author: goodman
Date: Wed Jul 24 20:16:50 2013
New Revision: 1506691

URL: http://svn.apache.org/r1506691
Log:
CLIMATE-215 - Change optional argument formatting in docstring

Modified:
    incubator/climate/branches/RefactorInput/ocw/plotter.py

Modified: incubator/climate/branches/RefactorInput/ocw/plotter.py
URL: http://svn.apache.org/viewvc/incubator/climate/branches/RefactorInput/ocw/plotter.py?rev=1506691&r1=1506690&r2=1506691&view=diff
==============================================================================
--- incubator/climate/branches/RefactorInput/ocw/plotter.py (original)
+++ incubator/climate/branches/RefactorInput/ocw/plotter.py Wed Jul 24 20:16:50 2013
@@ -52,18 +52,15 @@ class Plotter:
         '''
         Plotter Constructor.
         
-        Arguments:
         :param evaluation: An evaluation that has been previously ran for a
             series of datasets.
         :type evaluation: Evaluation 
-        
-        Keyword Arguments:
-        :param work_dir: The working directory to save generated figures.
+        :param workdir: The working directory to save generated figures.
         	If set to None, it will be set to your current working directory.
-        :type work_dir: str or None
+        :type work_dir: [optional] str or None
         :param fmt: The file type to save figures. Supported formats include
             png, eps, and pdf.
-        :type fmt: str 
+        :type fmt: [optional] str 
         '''
         if workdir is None:
             workdir = os.getcwd()
@@ -75,7 +72,7 @@ class Plotter:
     def assign_plot_data(self, evaluation):
         '''
         Builds a list of plotting functions and corresponding arguments based
-        on the shape of the each result in the evaluation.
+        on the shape of each result in the evaluation.
         
         Plotting function shapes are based on the length of the following 
         evaluation attributes (X denotes an arbitrary value):
@@ -187,10 +184,10 @@ def _fig_size(gridshape):
     Purpose::
         Calculates the figure dimensions from a subplot gridshape
         
-    Inputs::
+    Input::
         gridshape - Tuple denoting the subplot gridshape
         
-    Outputs::
+    Output::
         width - float for width of the figure in inches
         height - float for height of the figure in inches
     '''



Mime
View raw message