Docs - Reading Docs
If you've read technical documentation before, our method should be familiar. If not, let's review some of the things we do in these docs.
In the articles explaining functions, this site uses the following format to explain the syntax of their calls:
| open | ||
|---|---|---|
| Item | Description | |
| returntype | The type of the variable that will be returned. Mixed means that multiple types can be returned. | |
| function | The name of the function to call. | |
| type | The type of the parameter to send. | |
| param | The name of the parameter to send. | |
Enclosing the third param are brackets. Anything inside brackets is optional.
Although the syntax for Rules is similar, there are a few differences.
Because the syntax of rules generally use brackets, parentheses are now used to signify optional items. returntype is neglected as SUIT rules will always return a string. In fact, you can only send strings as parameters. The reason we still show a type is to tell what type to use when the rule will treat the parameter as JSON and decode it.
