Algorithm auto-generated GUI: Have the ability to add a few lines of descriptive text to help guide users.

[Janik Zikovsky]

• Perhaps a Algorithm->setHelp("string") function is called in init()
• This is then displayed, if set, in the GUI

[Janik Zikovsky]

Optional message is possible in MantidUI, but seems unused.

[Janik Zikovsky]

(In [7230]) Refs #1855: Added ability to display an optional message in an algorithm's auto-generated GUI dialog. Added one for a couple of algorithms.

[Janik Zikovsky]

(In [7233]) Refs #1855: More quick help in some algorithms

[Nick Draper]

Janik,

The message was added primarily for use in users scripts. It is fine to use it here as well,but if the users sets the message in Python I guess it should overwite any set in the algorithm itself.

I'm thinking of

Load(file1,"ws1", message="Specify the Empty can file")
Load(file1,"ws2", message="Specify the data file")

[Janik Zikovsky]

I tried the syntax below and got the error: "Load() got an unexpected keyword argument 'message'" looks like the message keyword is not in the python API?

Janik

Replying to Nick Draper:

Janik,

The message was added primarily for use in users scripts. It is fine to use it here as well,but if the users sets the message in Python I guess it should overwite any set in the algorithm itself.

I'm thinking of

Load(file1,"ws1", message="Specify the Empty can file")
Load(file1,"ws2", message="Specify the data file")

[Janik Zikovsky]

works!

[Michael Whitty]

works.

[Stuart Campbell]

This ticket has been transferred to github issue ​2702