exampleFunc

function (exampleFunc arg1 arg2 [arg3]) → result

Description of the example function. If we have a long description, only the first sentence will be displayed in the auto summary.

Multiple paragraphs are OK too

Parameters:

arg1 : string

The first argument goes first

arg2 : list

This is the second argument. It comes after the first

arg3

compact description of arg3

Returns:

Describe the output from the function here

We can use space separated tables to decribe a set of option. For example the flags argument has the following meanings:

flags	Meaning
0x001	capitalize
0x002	pluralize
0x004	prefix with ‘the’ or ‘a’
0x008	prefix with count (or ‘a’)
0x010	prefix with count
0x020	no modifiers
0x040	prefix with ‘the’ or ‘this’ or ‘these’
0x080	short form of name
0x100	actual name

Example

Still need to fix the formatting for example sections >>> (exampleFunc 1 2) >>> Unknown function [exampleFunc]

Note

This is not a real function

Warning

This is really important