help

describe, help


describe

Syntax

describe('category', 'page', 'syntax', ['description'], ['examples'], ['seealso'])

Description

Adds a help page to the database.

Examples

describe('#mine', 'countIf', '+count = countIf(@array, <value>)', 'Counts the number of items in @array that is equal to <value>.', "n = countIf(@fruits, 'apple')")

help

Syntax

help('page'|'/search')

Description

Prints a help page or searches the help database for text. Function syntax is documented with the following conventions:

- Arguments in [ ] brackets are optional and default values may be documented like this: [arg = value]
- Vertical bar | is used to separate alternatives
- ... means repeat 0 or more times
- "Type classes" can be identified as follows: ?boolean, +number, 'string', >function, @reference, <arbitrary>

Type help('#categories') for a list of valid categories. help('#pages') lists all available help pages. You can also search the entire help database for a string with help('/search')

Examples

help('#categories')
help('#pages')
help('#utils')
help('args')
help('/delete')