Skip to content

Commit ca07c51

Browse files
committed
(#130) Chain (Python): Resolve TODO. Add SimpleFilter tutorial reference. Fix minor typos in Chain and Cache tutorials
Signed-off-by: EsipovPA <esipov.p@mail.ru>
1 parent c31a7a9 commit ca07c51

File tree

3 files changed

+4
-6
lines changed

3 files changed

+4
-6
lines changed

doc/Tutorials/Cache-Cpp.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ Now open the ``CMakeLists.txt`` add the executable and name it ``cache_tutorial`
293293
294294
ament_auto_add_executable(cache_tutorial src/cache_tutorial.cpp)
295295
296-
Finally, add the install(TARGETS…) section so ros2 run can find your executable:
296+
Finally, add the ``install(TARGETS…)`` section so ros2 run can find your executable:
297297

298298
.. code-block:: CMake
299299

doc/Tutorials/Chain-Cpp.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,7 @@ Now open the ``CMakeLists.txt`` add the executable and name it ``chain_tutorial`
445445
446446
ament_auto_add_executable(chain_tutorial src/chain_tutorial.cpp)
447447
448-
Finally, add the install(TARGETS…) section so ros2 run can find your executable:
448+
Finally, add the ``install(TARGETS…)`` section so ros2 run can find your executable:
449449

450450
.. code-block:: CMake
451451

doc/Tutorials/Chain-Python.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ It allows you to store an N-long set of filters inside a single structure, makin
1111
To demonstrate the functionality of the ``Chain`` filter in a more clear manner, we are going to add a custom filter to this tutorial.
1212
This is going to be the ``CounterFilter`` that will be counting the number of messages passing through it.
1313
This filter class will be a successor to the ``SimpleFilter`` class, but this is a topic for another tutorial.
14-
15-
.. TODO: @EsipovPA: Add message_filters.SimpleFilter tutorial reference, when ready
14+
For more information on this topic, please refer to the `SimpleFilter for Python tutorial <https://docs.ros.org/en/rolling/p/message_filters/doc/Tutorials/SimpleFilter-Python.html>`.
1615

1716
Prerequisites
1817
~~~~~~~~~~~~~
@@ -174,8 +173,7 @@ The ``add`` method increases messages count, and passes messages to the followin
174173
The ``connectInput`` connects this filter to a previous filter's output.
175174
The ``counter`` property grants access to the current messages count.
176175

177-
.. More on this succession mechanism should be in the corresponding tutorial
178-
.. TODO: @EsipovPA Add link to the message_filters.SimpleFilter tutorial, when added.
176+
For more information on this succession mechanism, please refer to the `SimpleFilter for Python tutorial <https://docs.ros.org/en/rolling/p/message_filters/doc/Tutorials/SimpleFilter-Python.html>`.
179177

180178
And now we can turn our attention to the main tutorial class, that is the ``ChainNode`` class.
181179
For starters, let's take a look at the ``__init__`` method of this class:

0 commit comments

Comments
 (0)