How to Customize Help


Iguana includes help functions that allow you to create help for your own library code. You can also change the help for built-in functions, if needed.

Task [top]

How to Customize Help.

Implementation [top]

To change the help displayed above for help.set:

function main()
   local h = help.get(help.set)
   h.Desc = 'I changed the description'
   h.Usage = 'You have to guess'
   h.Examples = nil
   h.Parameters = nil

   help.set{input_function=help.set, help_data=h}

   -- reset to built in help  


Here is the result:

More information [top]

Leave A Comment?