Extend doc string for sww_merge

anuga/abstract_2d_finite_volumes/generic_domain.py

@@ -1457,11 +1457,19 @@ def set_timestepping_method(self, timestepping_method):
     def get_name(self):
         return self.simulation_name
 
+    def get_global_name(self):
+        return self.simulation_name
+
     def set_name(self, name=None, timestamp=False):
         """Assign a name to this simulation.
+
         This will be used to identify the output sww file.
         Without parameters the name will be derived from the script file,
         ie run_simulation.py -> output_run_simulation.sww
+
+        :param str name: name of simulation, 
+            and in particular the base name of the sww output file
+        :param bool timestamp: add a timestamp to the simulation name
         """
 
         import os

anuga/parallel/parallel_shallow_water.py

@@ -160,6 +160,13 @@ def apply_fractional_steps(self):
 
 
     def sww_merge(self, verbose=False, delete_old=False):
+        '''Merge all the sub domain sww files into a global sww file
+        
+        :param bool verbose: Flag to produce more output
+        :param bool delete_old: Flag to delete sub domain sww files after
+            creating global sww file
+            
+        '''
 
         # make sure all the computations have finished
 

anuga/shallow_water/shallow_water_domain.py

@@ -2699,6 +2699,13 @@ def store_timestep(self):
 
 
     def sww_merge(self,  *args, **kwargs):
+        '''Merge all the sub domain sww files into a global sww file
+        
+        :param bool verbose: Flag to produce more output
+        :param bool delete_old: Flag to delete sub domain sww files after
+            creating global sww file
+            
+        '''
 
         pass