Add docstrings and 'TODO'

.idea/active_bands_evolution.iml

@@ -5,8 +5,7 @@
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
   </component>
-  <component name="PyDocumentationSettings">
-    <option name="format" value="PLAIN" />
-    <option name="myDocStringFormat" value="Plain" />
+  <component name="PackageRequirementsSettings">
+    <option name="requirementsPath" value="" />
   </component>
 </module>
\ No newline at end of file

active_channel_evolution.py

@@ -96,6 +96,8 @@ class active_channel_evolution:
         :returns: Translated version of message.
         :rtype: QString
         """
+
+
         # noinspection PyTypeChecker,PyArgumentList,PyCallByClass
         return QCoreApplication.translate('active_channel_evolution', message)
 

active_channel_evolution_processing.py

@@ -3,7 +3,35 @@
 
 def active_channel_processing(QgsProject, QgsVectorLayer, outputs, QgsProcessing, processing, selected_layer_ac, input_blocks_vb,
                               export_ac, export_csv_ac, flag_load_temp_ac, name_active_channel_blocks, name_active_channel_centerline):
-    """Calculation of the blocks of the active channel"""
+    """
+
+    @param QgsProject:
+    @type QgsProject:
+    @param QgsVectorLayer:
+    @type QgsVectorLayer:
+    @param outputs:
+    @type outputs:
+    @param QgsProcessing:
+    @type QgsProcessing:
+    @param processing:
+    @type processing:
+    @param selected_layer_ac:
+    @type selected_layer_ac:
+    @param input_blocks_vb:
+    @type input_blocks_vb:
+    @param export_ac:
+    @type export_ac:
+    @param export_csv_ac:
+    @type export_csv_ac:
+    @param flag_load_temp_ac:
+    @type flag_load_temp_ac:
+    @param name_active_channel_blocks:
+    @type name_active_channel_blocks:
+    @param name_active_channel_centerline:
+    @type name_active_channel_centerline:
+    @return:
+    @rtype:
+    """
     # we remove the islands from the active channel layer
     alg_params = {
         'INPUT': selected_layer_ac,

detect_starting_point.py

@@ -2,7 +2,26 @@
 # this script detects the first digitized point of the valley bottom
 
 def detect_starting_point(QgsProject, outputs, QgsProcessing, processing, selected_layer_vb, name_starting_point):
-    # we extract the vertex 0 of the polygon layer of the valley bottom
+    """
+    TODO
+    We extract the vertex 0 of the polygon layer of the valley bottom
+
+    :param QgsProject:
+    :type QgsProject:
+    :param outputs:
+    :type outputs:
+    :param QgsProcessing:
+    :type QgsProcessing:
+    :param processing:
+    :type processing:
+    :param selected_layer_vb:
+    :type selected_layer_vb:
+    :param name_starting_point:
+    :type name_starting_point:
+    :return:
+    :rtype:
+    """
+
     alg_params = {
         'INPUT': selected_layer_vb,
         'VERTICES':'0',

valley_bottom_processing.py

@@ -4,8 +4,46 @@
 def valley_bottom_processing(QgsProject, QgsVectorLayer, outputs, QgsProcessing, processing, selected_layer_vb, flag_reverse_vb, cross_section_width,
                              distance_cross_section, export_vb, export_csv_vb, flag_load_temp_vf, name_valley_bottom_blocks,
                              name_valley_bottom_centerline, name_valley_bottom_cross_sections, name_valley_bottom_rk):
+    """
+    TODO
+    Calculation of the blocks of the valley bottom
+
+    :param QgsProject:
+    :type QgsProject:
+    :param QgsVectorLayer:
+    :type QgsVectorLayer:
+    :param outputs:
+    :type outputs:
+    :param QgsProcessing:
+    :type QgsProcessing:
+    :param processing:
+    :type processing:
+    :param selected_layer_vb:
+    :type selected_layer_vb:
+    :param flag_reverse_vb:
+    :type flag_reverse_vb:
+    :param cross_section_width:
+    :type cross_section_width:
+    :param distance_cross_section:
+    :type distance_cross_section:
+    :param export_vb:
+    :type export_vb:
+    :param export_csv_vb:
+    :type export_csv_vb:
+    :param flag_load_temp_vf:
+    :type flag_load_temp_vf:
+    :param name_valley_bottom_blocks:
+    :type name_valley_bottom_blocks:
+    :param name_valley_bottom_centerline:
+    :type name_valley_bottom_centerline:
+    :param name_valley_bottom_cross_sections:
+    :type name_valley_bottom_cross_sections:
+    :param name_valley_bottom_rk:
+    :type name_valley_bottom_rk:
+    :return:
+    :rtype:
+    """
 
-    """Calculation of the blocks of the valley bottom"""
     # We delete the islands of the valley bottom (i.e. the 'holes' in the polygon of the valley bottom layer)
     alg_params = {
         'INPUT': selected_layer_vb,