Skip to content

Commit 75c4c33

Browse files
committed
syntax
1 parent b093a53 commit 75c4c33

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

doc/platform/app/app_roles.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -74,19 +74,21 @@ defined by roles dependencies.
7474

7575
The ``on_event`` callback provides 3 arguments, when it is called:
7676

77-
- ``config``, which contains the configuration of the role;
77+
- ``config``, which contains the configuration of the role;
7878

79-
- ``key``, which reflects the trigger event:
80-
- ``config.apply`` if the callback was triggered by a configuration update;
81-
- ``box.status`` if it was triggered by the ``box.status`` system event.
82-
83-
- ``value``, which shows and logs the information about the instance status as in the trigger ``box.status`` system event. If the callback is triggered by a configuration update, the ``value`` shows the information of the most recent ``box.status`` system event.
79+
- ``key``, which reflects the trigger event:
80+
- ``config.apply`` if the callback was triggered by a configuration update;
81+
- ``box.status`` if it was triggered by the ``box.status`` system event.
82+
- ``value``, which shows and logs the information about the instance status as in the trigger ``box.status`` system event.
83+
If the callback is triggered by a configuration update, the ``value`` shows the information of the most recent ``box.status`` system event.
8484

8585
.. NOTE::
8686

87-
- All ``on_event`` callbacks with the ``config.apply`` key are executed as a part of the configuration process. Process statuses ``ready`` or ``check_warnings`` are reached only after all such ``on_event`` callbacks are done.
87+
- All ``on_event`` callbacks with the ``config.apply`` key are executed as a part of the configuration process.
88+
Process statuses ``ready`` or ``check_warnings`` are reached only after all such ``on_event`` callbacks are done.
8889

89-
- All ``on_event`` callbacks are executed inside of a ``pcall``. If an error is raised for a callback, it is logged with the ``error`` level and the series execution continues.
90+
- All ``on_event`` callbacks are executed inside of a ``pcall``. If an error is raised for a callback, it is logged
91+
with the ``error`` level and the series execution continues.
9092

9193
Creating a custom role includes the following steps:
9294

0 commit comments

Comments
 (0)