Improve help strings

Author: anitagraser

qgis_processing/overlayAlgorithm.py

@@ -18,12 +18,6 @@
     QgsProcessingParameterFeatureSource,
     QgsProcessingParameterString,
     QgsProcessingParameterExtent,
-    QgsProcessingParameterField,
-    QgsProcessingParameterNumber,
-    QgsProcessingParameterBoolean,
-    QgsProcessingParameterFeatureSink,
-    QgsProcessingParameterEnum,
-    QgsWkbTypes,
 )
 
 sys.path.append("..")
@@ -56,7 +50,7 @@ def displayName(self):
         return self.tr("Clip trajectories by extent")
 
     def group(self):
-        return self.tr("Overlay")
+        return self.tr("Trajectory overlay")
 
     def groupId(self):
         return "TrajectoryOverlay"

qgis_processing/splitTrajectoriesAlgorithm.py

@@ -54,6 +54,11 @@ def shortHelpString(self):
             "https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.to_timedelta.html)</p>"
             "<p>For more information on trajectory splitters see: "
             "https://movingpandas.readthedocs.io/en/main/trajectorysplitter.html</p>"
+            "<p><b>Speed</b> is calculated based on the input layer CRS information and "
+            "converted to the desired speed units. For more info on the supported units, "
+            "see https://movingpandas.org/units</p>"
+            "<p><b>Direction</b> is calculated between consecutive locations. Direction "
+            "values are in degrees, starting North turning clockwise.</p>"
         )
 
     def processTc(self, tc, parameters, context):
@@ -102,6 +107,11 @@ def shortHelpString(self):
             "using regular time intervals (year, month, day, hour): </p>"
             "<p>For more information on trajectory splitters see: "
             "https://movingpandas.readthedocs.io/en/main/trajectorysplitter.html</p>"
+            "<p><b>Speed</b> is calculated based on the input layer CRS information and "
+            "converted to the desired speed units. For more info on the supported units, "
+            "see https://movingpandas.org/units</p>"
+            "<p><b>Direction</b> is calculated between consecutive locations. Direction "
+            "values are in degrees, starting North turning clockwise.</p>"
         )
 
     def processTc(self, tc, parameters, context):
@@ -149,10 +159,14 @@ def displayName(self):
 
     def shortHelpString(self):
         return self.tr(
-            "<p>Splits trajectories into subtrajectories "
-            "at stops. </p>"
+            "<p>Splits trajectories into subtrajectories at stops. </p>"
             "<p>For more information on trajectory splitters see: "
             "https://movingpandas.readthedocs.io/en/main/trajectorysplitter.html</p>"
+            "<p><b>Speed</b> is calculated based on the input layer CRS information and "
+            "converted to the desired speed units. For more info on the supported units, "
+            "see https://movingpandas.org/units</p>"
+            "<p><b>Direction</b> is calculated between consecutive locations. Direction "
+            "values are in degrees, starting North turning clockwise.</p>"
         )
 
     def processTc(self, tc, parameters, context):

qgis_processing/trajectoolsProvider.py

@@ -28,7 +28,7 @@ def id(self):
         return "Trajectory"
 
     def name(self):
-        return "Trajectory tools for Processing"
+        return "Trajectory tools"
 
     def icon(self):
         return QIcon(os.path.join(pluginPath, "icons", "icon.png"))