simple-squiggle

A restricted subset of Squiggle
Log | Files | Refs | README

help.md (755B)

      1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
      2 
      3 # Function help
      4 
      5 Retrieve help on a function or data type.
      6 Help files are retrieved from the embedded documentation in math.docs.
      7 
      8 
      9 ## Syntax
     10 
     11 ```js
     12 math.help(search)
     13 ```
     14 
     15 ### Parameters
     16 
     17 Parameter | Type | Description
     18 --------- | ---- | -----------
     19 `search` | Function &#124; string &#124; Object | A function or function name for which to get help
     20 
     21 ### Returns
     22 
     23 Type | Description
     24 ---- | -----------
     25 Help | A help object
     26 
     27 
     28 ### Throws
     29 
     30 Type | Description
     31 ---- | -----------
     32 
     33 
     34 ## Examples
     35 
     36 ```js
     37 console.log(math.help('sin').toString())
     38 console.log(math.help(math.add).toString())
     39 console.log(math.help(math.add).toJSON())
     40 ```
     41 
     42