Skip to content

Commit 0abd3fd

Browse files
ghtmttnyalldawson
authored andcommitted
add shortHelpString in script template
1 parent 966bb17 commit 0abd3fd

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

python/plugins/processing/script/ScriptTemplate.py

+8
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,14 @@ def groupId(self):
7272
"""
7373
return 'examplescripts'
7474

75+
def shortHelpString(self):
76+
"""
77+
Returns a localised short helper string for the algorithm. This string
78+
should provide a basic description about what the algorithm does and the
79+
parameters and outputs associated with it..
80+
"""
81+
return self.tr("Example algorithm short description")
82+
7583
def initAlgorithm(self, config=None):
7684
"""
7785
Here we define the inputs and output of the algorithm, along

0 commit comments

Comments
 (0)