Skip to content

Commit 9ba3763

Browse files
olivier-stassemergify[bot]
authored andcommitted
Minor fixes in documentation (example_1 and example_12) (#361)
* [example_1/doc] Specify that step 1 is optional. Two in * [example_12/README.md] Fix wrong title in README.md --------- Co-authored-by: Olivier Stasse <[email protected]> (cherry picked from commit 40b92dd)
1 parent f99ff56 commit 9ba3763

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

example_1/doc/userdoc.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The *RRBot* URDF files can be found in the ``description/urdf`` folder.
2424
Tutorial steps
2525
--------------------------
2626

27-
1. To check that *RRBot* descriptions are working properly use following launch commands
27+
1. (Optional) To check that *RRBot* descriptions are working properly use following launch commands
2828

2929
.. code-block:: shell
3030
@@ -50,6 +50,7 @@ Tutorial steps
5050
5151
rviz2 --display-config `ros2 pkg prefix ros2_control_demo_example_1`/share/ros2_control_demo_example_1/rviz/rrbot.rviz
5252
53+
Once it is working you can stop rviz using CTRL+C as the next launch file is starting RViz.
5354
5455
2. To start *RRBot* example open a terminal, source your ROS2-workspace and execute its launch file with
5556

@@ -61,7 +62,7 @@ Tutorial steps
6162
In starting terminal you will see a lot of output from the hardware implementation showing its internal states.
6263
This is only of exemplary purposes and should be avoided as much as possible in a hardware interface implementation.
6364

64-
If you can see two orange and one yellow rectangle in in *RViz* everything has started properly.
65+
If you can see two orange and one yellow rectangle in *RViz* everything has started properly.
6566
Still, to be sure, let's introspect the control system before moving *RRBot*.
6667

6768
3. Check if the hardware interface loaded properly, by opening another terminal and executing

example_12/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ros2_control_demo_example_12
22

3-
This example demonstrates the switching between simulation and real hardware by means of the *RRBot* - or ''Revolute-Revolute Manipulator Robot''.
3+
This example shows how to write a simple chainable controller, and how to integrate it properly to have a functional controller chaining.
44

55
Find the documentation in [doc/userdoc.rst](doc/userdoc.rst) or on [control.ros.org](https://control.ros.org/master/doc/ros2_control_demos/example_12/doc/userdoc.html).

0 commit comments

Comments
 (0)