Skip to content

Commit 3694dc2

Browse files
Update docs to use proper RST literals (#837)
Signed-off-by: Christophe Bedard <[email protected]>
1 parent 151b024 commit 3694dc2

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

launch/doc/source/architecture.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ This is a non-exhaustive list of actions that `launch` may provide:
9090

9191
- :class:`launch.actions.LogInfo`:
9292

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.
9494

9595
- :class:`launch.actions.RaiseError`
9696

@@ -142,7 +142,7 @@ There are many possible variations of a substitution, but here are some of the c
142142
- :class:`launch.substitutions.LocalSubstitution`
143143

144144
- 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.
146146

147147
- :class:`launch.substitutions.EnvironmentVariable`
148148

@@ -191,7 +191,7 @@ Event handlers define two main methods, the :meth:`launch.EventHandler.matches`
191191
The matches method gets the event as input and must return `True` if the event handler matches that event, or `False` otherwise.
192192
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.
193193

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.
195195

196196
Extension Points
197197
----------------
@@ -215,4 +215,4 @@ External Python packages, through extension points, may add:
215215

216216
- must directly or indirectly inherit from :class:`launch.LaunchDescriptionEntity`
217217

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

Comments
 (0)