[QGIS-Developer] Adding help text for processing plugin

Nyall Dawson nyall.dawson at gmail.com
Tue May 8 14:12:32 PDT 2018

On 9 May 2018 at 06:52, Phil Ribbens <philip.ribbens at gmail.com> wrote:
> Hi,
> I’m wondering if it’s possible to add help text (that will show up in
> right-hand sidebar) for a processing plugin that I’m developing in QGIS3.
> I think I found where the help text for the native QGIS plugins comes from
> (https://github.com/qgis/QGIS/blob/master/python/plugins/processing/algs/help/qgis.yaml),
> but I’m not sure how I might be able to provide my own help text for a
> processing plugin I’m developing.

You just need to implement the shortHelpString method in your
algorithm and return the translated help text.


> Thanks,
> Phil Ribbens
> _______________________________________________
> QGIS-Developer mailing list
> QGIS-Developer at lists.osgeo.org
> List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

More information about the QGIS-Developer mailing list