diff --git a/python/core/auto_generated/processing/qgsprocessingparameters.sip.in b/python/core/auto_generated/processing/qgsprocessingparameters.sip.in index 7d7c64fdd5e..efb11c4f2c9 100644 --- a/python/core/auto_generated/processing/qgsprocessingparameters.sip.in +++ b/python/core/auto_generated/processing/qgsprocessingparameters.sip.in @@ -379,6 +379,9 @@ used to identify this parameter. %Docstring Returns the help for the parameter. +This is a descriptive (possibly lengthy), translated string explaining +the parameter's behavior and use in depth. + .. seealso:: :py:func:`setHelp` .. versionadded:: 3.16 @@ -388,6 +391,9 @@ Returns the help for the parameter. %Docstring Sets the ``help`` for the parameter. +The ``help`` string should be a descriptive, translated string explaining +the parameter's behavior and use in depth. + .. seealso:: :py:func:`help` .. versionadded:: 3.16 diff --git a/src/core/processing/qgsprocessingparameters.h b/src/core/processing/qgsprocessingparameters.h index 59bc5f9f12d..09a1b03db80 100644 --- a/src/core/processing/qgsprocessingparameters.h +++ b/src/core/processing/qgsprocessingparameters.h @@ -482,6 +482,10 @@ class CORE_EXPORT QgsProcessingParameterDefinition /** * Returns the help for the parameter. + * + * This is a descriptive (possibly lengthy), translated string explaining + * the parameter's behavior and use in depth. + * * \see setHelp() * \since QGIS 3.16 */ @@ -489,6 +493,10 @@ class CORE_EXPORT QgsProcessingParameterDefinition /** * Sets the \a help for the parameter. + * + * The \a help string should be a descriptive, translated string explaining + * the parameter's behavior and use in depth. + * * \see help() * \since QGIS 3.16 */