Modify docstrings

C2SM · Jan 8, 2024 · 767ec08 · 767ec08
1 parent 5c43231
commit 767ec08
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 7 deletions.
diff --git a/jobs/geosp.py b/jobs/geosp.py
@@ -11,7 +11,8 @@
 
 def main(cfg):
     """
-    Add GEOSP to all meteo files
+    The constant variable 'GEOSP' is added to the files not containing it
+    using python-cdo bindings.
     """
     prepare_data.set_cfg_variables(cfg)
     launch_time = cfg.init_time_logging("geosp")

diff --git a/jobs/icontools.py b/jobs/icontools.py
@@ -15,6 +15,13 @@
 
 
 def main(cfg):
+    """
+    - Submit the runscript for the DWD ICON tools to remap the meteorological files.
+    - All runscripts specified in ``cfg.icontools_runjobs`` are submitted.
+    - The meteorological files are read from the original input directory
+      (``cfg.input_root_meteo``), and the remapped meteorological files are saved
+      in the input folder on scratch (``cfg.icon_input/icbc``).
+    """
     launch_time = cfg.init_time_logging("icontools")
 
     #-----------------------------------------------------

diff --git a/jobs/prepare_data.py b/jobs/prepare_data.py
@@ -73,13 +73,7 @@ def main(cfg):
     copying meteorological files, and handling specific data processing for each model.
 
     **ICON:**
-
     - Create directories ``cfg.icon_input_icbc`` and ``cfg.icon_work``.
-    - Submit the runscript for the DWD ICON tools to remap the meteorological files.
-    - All runscripts specified in ``cfg.icontools_runjobs`` are submitted.
-    - The meteorological files are read from the original input directory (``cfg.input_root_meteo``),
-      and the remapped meteorological files are saved in the input folder on scratch (``cfg.icon_input/icbc``).
-    - The constant variable 'GEOSP' is added to the files not containing it using python-cdo bindings.
 
     **COSMO:**