In this document, a unique notation is used to describe input parameters for functions and methods. This notation differs from standard Python syntax and is specifically applied in the parameters description sections:
-
<param> - Represents a mandatory positional parameter. This parameter must be provided when the function is called.
-
[param] - Indicates an optional positional parameter. This parameter can be omitted when calling the function. If omitted, the function uses the default value.
-
[<param>] - Indicates an optional non-positional parameter. This parameter can be specified by name and can be omitted. If omitted, the function uses the default value.
-
param=defaultValue - This is the same as the non-positional parameter above, but this notation is used only in the 'Syntax' section of each function description.
This notation helps clarify the requirements and options for each function's parameters, ensuring a clear understanding of how to use them.