Gimp.Procedure.set_documentation

@accepts(Gimp.Procedure, unicode, unicode, unicode)
@returns(none)
def set_documentation(self, blurb, help, help_id):
    # Python wrapper for gimp_procedure_set_documentation()
  

Sets various documentation strings on self:

* blurb is used for instance as the self's tooltip when represented in the UI such as a menu entry. * help is a free-form text that's meant as additional documentation for developers of scripts and plug-ins. If the blurb and the argument names and descriptions are enough for a quite self-explanatory procedure, you may set help to None, rather than setting an uninformative help (avoid setting the same text as blurb or redundant information).

Plug-ins are responsible for their own translations. You are expected to send localized strings of blurb and help to GIMP if your plug-in is internationalized.

Since 3.0

self

A Gimp.Procedure.

blurb

The self's blurb.

help

The self's help text.

help_id

The self's help ID.