You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: launch/doc/source/architecture.rst
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -90,7 +90,7 @@ This is a non-exhaustive list of actions that `launch` may provide:
90
90
91
91
- :class:`launch.actions.LogInfo`:
92
92
93
-
- This action will log a user defined message to the logger, other variants (e.g. `LogWarn`) could also exist.
93
+
- This action will log a user defined message to the logger, other variants (e.g. ``LogWarn``) could also exist.
94
94
95
95
- :class:`launch.actions.RaiseError`
96
96
@@ -142,7 +142,7 @@ There are many possible variations of a substitution, but here are some of the c
142
142
- :class:`launch.substitutions.LocalSubstitution`
143
143
144
144
- This substitution gets a "local" variable out of the context. This is a mechanism that allows a "parent" action to pass information to sub actions.
145
-
- As an example, consider this pseudo code example `OnShutdown(actions=LogInfo(msg=["shutdown due to: ", LocalSubstitution(expression='event.reason')]))`, which assumes that `OnShutdown` will put the shutdown event in the locals before `LogInfo` is visited.
145
+
- As an example, consider this pseudo code example ``OnShutdown(actions=LogInfo(msg=["shutdown due to: ", LocalSubstitution(expression='event.reason')]))``, which assumes that ``OnShutdown`` will put the shutdown event in the locals before ``LogInfo`` is visited.
@@ -191,7 +191,7 @@ Event handlers define two main methods, the :meth:`launch.EventHandler.matches`
191
191
The matches method gets the event as input and must return `True` if the event handler matches that event, or `False` otherwise.
192
192
The handle method gets the event and launch context as input, and can optionally (in addition to any side effects) return a list of :class:`launch.LaunchDescriptionEntity` objects to be visited by the launch service.
193
193
194
-
Event handlers do not inherit from :class:`launch.LaunchDescriptionEntity`, but can similarly be "visited" for each event processed by the launch service, seeing if `matches` returns `True` and if so following up with a call to `handle`, then visiting each of the actions returned by `handle`, depth-first.
194
+
Event handlers do not inherit from :class:`launch.LaunchDescriptionEntity`, but can similarly be "visited" for each event processed by the launch service, seeing if ``matches`` returns ``True`` and if so following up with a call to ``handle``, then visiting each of the actions returned by ``handle``, depth-first.
195
195
196
196
Extension Points
197
197
----------------
@@ -215,4 +215,4 @@ External Python packages, through extension points, may add:
215
215
216
216
- must directly or indirectly inherit from :class:`launch.LaunchDescriptionEntity`
217
217
218
-
In the future, more traditional extensions (like with `setuptools`' `entry_point` feature) may be available via the launch service, e.g. the ability to include some extra entities and event handlers before the launch description is included.
218
+
In the future, more traditional extensions (like with ``setuptools``' ``entry_point`` feature) may be available via the launch service, e.g. the ability to include some extra entities and event handlers before the launch description is included.
0 commit comments