doc: added tags to sections of script templates

Author: jlerat

hydrodiy/io/script_template_plot.py

@@ -41,7 +41,7 @@
 #importlib.reload(utils)
 
 #----------------------------------------------------------------------
-# Config
+# @Config
 #----------------------------------------------------------------------
 
 parser = argparse.ArgumentParser(\
@@ -81,7 +81,7 @@
 #proj = pyproj.Proj("+init=EPSG:{0}".format(args.projection))
 #
 #----------------------------------------------------------------------
-# Folders
+# @Folders
 #----------------------------------------------------------------------
 source_file = Path(__file__).resolve()
 
@@ -91,13 +91,13 @@
 fimg = [FIMG]
 
 #------------------------------------------------------------
-# Logging
+# @Logging
 #------------------------------------------------------------
 basename = source_file.stem
 LOGGER = iutils.get_logger(basename)
 
 #------------------------------------------------------------
-# Get data
+# @Get data
 #------------------------------------------------------------
 #fd = "%s/data.csv" % FDATA
 #data, comment = csv.read_csv(fd)
@@ -108,7 +108,7 @@
 LOGGER.info(mess)
 
 #------------------------------------------------------------
-# Plot
+# @Plot
 #------------------------------------------------------------
 
 # To use multipage pdf

hydrodiy/io/script_template_simple.py

@@ -24,7 +24,7 @@
 #spec.loader.exec_module(foo)
 
 #----------------------------------------------------------------------
-# Config
+# @Config
 #----------------------------------------------------------------------
 parser = argparse.ArgumentParser(\
     description="[DESCRIPTION]", \
@@ -59,7 +59,7 @@
 sitepattern = args.sitepattern
 
 #----------------------------------------------------------------------
-# Folders
+# @Folders
 #----------------------------------------------------------------------
 source_file = Path(__file__).resolve()
 froot = [FROOT]
@@ -68,15 +68,15 @@
 fimg = [FIMG]
 
 #----------------------------------------------------------------------
-# Logging
+# @Logging
 #----------------------------------------------------------------------
 basename = source_file.stem
 flog = froot / "logs" / f"{basename}.log"
 flog.parent.mkdir(exist_ok=True)
 LOGGER = iutils.get_logger(basename, console=False, contextual=True)
 
 #----------------------------------------------------------------------
-# Get data
+# @Get data
 #----------------------------------------------------------------------
 fs = fdata / "sites.csv"
 allsites, _ = csv.read_csv(fs, index_col="siteid")
@@ -92,7 +92,7 @@
         sites = allsites.iloc[idx, :]
 
 #----------------------------------------------------------------------
-# Process
+# @Process
 #----------------------------------------------------------------------
 nsites = len(sites)
 for isite, (siteid, sinfo) in enumerate(sites.iterrows()):