itom.widgetHelp

itom.widgetHelp([widgetName, dictionary = 0, furtherInfos = 0]) → generates an online help for the given widget(s).

This method prints information about one specific widget or a list of widgets to the console output. If one specific widget, defined in an algorithm plugin can be found that case-sensitively fits the given widgetName its full documentation is printed. Else, a list of widgets is printed whose name contains the given widgetName.

Parameters:

widgetName : {str}, optional

is the fullname or a part of any widget-name which should be displayed. If widgetName is empty or no widget matches widgetName (case sensitive) a list with all suitable widgets is given.

dictionary : {dict}, optional

if dictionary == 1, a dictionary with all relevant components of the widget’s documentation is returned and nothing is printed to the command line [default: 0]

furtherInfos : {int}, optional

Usually, widgets whose name only contains the given widgetName are only listed at the end of the information text. If this parameter is set to 1 [default: 0], the full information for all these widgets is printed as well.

Returns:

out : {None or dict}

In its default parameterization this method returns None. Depending on the parameter dictionary it is also possible that this method returns a dictionary with the single components of the information text.