Changeset 3271 for TI02-CSML/trunk/csml/API/ops_RaggedSectionFeature.py

Timestamp:

25/01/08 15:13:21 (13 years ago)

Author:

domlowe

Message:

More docstrings

File:

• TI02-CSML/trunk/csml/API/ops_RaggedSectionFeature.py (modified) (3 diffs)

TI02-CSML/trunk/csml/API/ops_RaggedSectionFeature.py

@@ -1 @@
-''' ops_RaggedSectionFeature  contains operations for RaggedSectionFeatures'''
+''' ops_RaggedSectionFeature  contains operations for RaggedSectionFeatures. These methods are attached to GridFeature instances at runtime.'''
 import csml
 import MA,MV,Numeric
@@ -6 +6 @@
 
 def testmethod(self):
+    ''' test method'''
     print 'testmethod for ragged section feature'
     return 'testmethod 2'
 
 def getDomain(self):
-    #returns domain as a dictionary of ordinates {name: [values], ...}
+    '''returns domain as a dictionary of ordinates {name: [values], ...}'''
     self.domain={}
     
@@ -48 +49 @@
 
 def subsetByTime(self, outputdir=None, ncname='pointseries.nc' ,time=None):
+    ''' subset a ragged section by time
+    @param outputdir:    name of directory to write data files to
+    @param ncname:     name of netcdf file to write out
+    @param time:      subset selection by time.
+    @return:     subsettedFeature (RaggedSectionFeature)  pathToSubsetNetCDF (filepath), descriptor (array descriptor instance)
+    '''
+    
     descriptors=[]
     if outputdir is not None: