add shortHelpString in script template

qgis · Mar 31, 2018 · 0abd3fd · 0abd3fd
1 parent 966bb17
commit 0abd3fd
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/python/plugins/processing/script/ScriptTemplate.py b/python/plugins/processing/script/ScriptTemplate.py
@@ -72,6 +72,14 @@ def groupId(self):
         """
         return 'examplescripts'
 
+    def shortHelpString(self):
+        """
+        Returns a localised short helper string for the algorithm. This string
+        should provide a basic description about what the algorithm does and the
+        parameters and outputs associated with it..
+        """
+        return self.tr("Example algorithm short description")
+
     def initAlgorithm(self, config=None):
         """
         Here we define the inputs and output of the algorithm, along