[QGIS-Developer] Adding help text for processing plugin

[Phil Ribbens]

Perfect, thank you so much!

> On May 8, 2018, at 5:17 PM, Etienne Trimaille <etienne.trimaille at gmail.com> wrote:
> 
> You can check this example: https://github.com/qgis/QGIS/blob/master/python/plugins/processing/script/ScriptTemplate.py#L77 <https://github.com/qgis/QGIS/blob/master/python/plugins/processing/script/ScriptTemplate.py#L77>
> 
> 2018-05-08 17:12 GMT-04:00 Nyall Dawson <nyall.dawson at gmail.com <mailto:nyall.dawson at gmail.com>>:
> On 9 May 2018 at 06:52, Phil Ribbens <philip.ribbens at gmail.com <mailto: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 <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.
> 
> Nyall
> 
> 
> >
> > Thanks,
> > Phil Ribbens
> >
> > _______________________________________________
> > QGIS-Developer mailing list
> > QGIS-Developer at lists.osgeo.org <mailto:QGIS-Developer at lists.osgeo.org>
> > List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer <https://lists.osgeo.org/mailman/listinfo/qgis-developer>
> > Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer <https://lists.osgeo.org/mailman/listinfo/qgis-developer>
> _______________________________________________
> QGIS-Developer mailing list
> QGIS-Developer at lists.osgeo.org <mailto:QGIS-Developer at lists.osgeo.org>
> List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer <https://lists.osgeo.org/mailman/listinfo/qgis-developer>
> Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer <https://lists.osgeo.org/mailman/listinfo/qgis-developer>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20180508/cd673bb9/attachment-0001.html>