Document Conventions:conv

Symbols and Conventions Foundation

This document uses symbols and metasymbols to specify items in a general way. Symbols identify special items and behaviors. For example, keywords and metasymbols enclosed in square brackets are optional. The following is a complete list of symbols used in syntax:

Symbols
Symbol Description
<> Indicates an item you supply, such as a variable name or literal value.
() Within syntax specification, indicates function argument list. At the end of syntax specification, describes multiple behaviors.
[] Indicates optional item or list.
{} Indicates a code block or a literal array.
|| Indicates a code block argument list.
--> Indicates a function return value.
... Repeated elements if followed by a symbol. Intervening code if followed by a keyword.
, List item separator.
| Indicates two or more mutually exclusive options.
@ Indicates that an argument must be passed by reference.

Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.