43 lines
755 B
Markdown
43 lines
755 B
Markdown
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
||
|
|
|
||
|
|
# Function help
|
||
|
|
|
||
|
|
Retrieve help on a function or data type.
|
||
|
|
Help files are retrieved from the embedded documentation in math.docs.
|
||
|
|
|
||
|
|
|
||
|
|
## Syntax
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.help(search)
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Parameter | Type | Description
|
||
|
|
--------- | ---- | -----------
|
||
|
|
`search` | Function | string | Object | A function or function name for which to get help
|
||
|
|
|
||
|
|
### Returns
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
Help | A help object
|
||
|
|
|
||
|
|
|
||
|
|
### Throws
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
```js
|
||
|
|
console.log(math.help('sin').toString())
|
||
|
|
console.log(math.help(math.add).toString())
|
||
|
|
console.log(math.help(math.add).toJSON())
|
||
|
|
```
|
||
|
|
|
||
|
|
|