STYLE : Add comments for new python scripts

python_src/utils/generateConfigFile.py

@@ -19,6 +19,9 @@ import func_utils
 
 # Util fct for autocompletion
 def complete(text, state):
+    """ 
+    Function for autocompletion
+    """
     return (glob.glob(text+'*')+[None])[state]
 
 # Print with colors
@@ -33,6 +36,9 @@ def prBlack(skk): print("\033[98m {}\033[00m" .format(skk))
 
 # Input with colors
 def genericInput(skk, color) :
+    """ 
+    Override input function for colors and exceptions
+    """
     try:
         return input(color .format(skk)) 
     except KeyboardInterrupt :
@@ -54,6 +60,11 @@ def inBlack(skk): return genericInput(skk, "\033[98m {}\033[00m")
 
 # Questions to user for SAR_MultiSlc* chains
 def askForMultiSlc(dataConfig) :
+    """ 
+    Q&A for SAR_MultiSlc* chains
+    Modify the dataConfig following user's awnsers 
+    """
+
     # Select sensor if SAR_MultiSlc
     sensor = "S1IW"
     if (response == "SAR_MultiSlc") :
@@ -188,6 +199,11 @@ def askForMultiSlc(dataConfig) :
 
 # Questions to user for diapOTB* chains
 def askForDiapOTB(dataConfig) :
+    """ 
+    Q&A for diapOTB* chains
+    Modify the dataConfig following user's awnsers 
+    """
+
     # Select sensor if diapOTB
     sensor = "S1IW"
     if (response == "diapOTB") :

python_src/utils/getEOFFromESA.py

 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+""" 
+    getEOFFromESA.py
+    ================
+
+    Python script to retrieve from ESA website, the EOF files
+ 
+"""
+
 import re
 import os
 import time