About documentation¶
Conventions and symbols
This documentation is written using the following conventions:
- italic - this formatting is used to mark user interface elements.
example
- this formatting is used to write example value of a parameter, API method name or code example.- Note field:
Note
Note field usually contains additional information closely related with described topic, e.g. suggestion concerning given procedure step; additional conditions which have to be met.
- Warning field:
Warning
Warning field usually contains essential information concerning system’s operation. Not adhering to this information may have irreversible consequences.