Skip to content

Commit 6de7fb9

Browse files
Add keyboard markup (#3695)
* add keyboard markup Co-authored-by: Chris Lalancette <[email protected]>
1 parent ebb3c98 commit 6de7fb9

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

source/Releases/Release-Dashing-Diademata.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -772,7 +772,7 @@ Known Issues
772772
773773
* `[ros2/rclcpp#715] <https://github.com/ros2/rclcpp/issues/715>`_ There is an inconsistency in the way that parameter YAML files are loaded between standalone ROS 2 nodes and composed ROS 2 nodes.
774774
Currently available workarounds are noted in an `issue comment <https://github.com/ros2/rclcpp/issues/715#issuecomment-497392626>`_
775-
* `[ros2/rclpy#360] <https://github.com/ros2/rclpy/issues/360>`_ rclpy nodes ignore ``ctrl-c`` when using OpenSplice on Windows.
775+
* `[ros2/rclpy#360] <https://github.com/ros2/rclpy/issues/360>`_ rclpy nodes ignore :kbd:`ctrl-c` when using OpenSplice on Windows.
776776
* `[ros2/rosidl_typesupport_opensplice#30] <https://github.com/ros2/rosidl_typesupport_opensplice/issues/30>`_ There is a bug preventing nesting a message inside of a service or action definition with the same name when using OpenSplice.
777777
* `[ros2/rclcpp#781] <https://github.com/ros2/rclcpp/pull/781>`_ Calling ``get_parameter``/``list_parameter`` from within ``on_set_parameter_callback`` causes a deadlock on Dashing. This is fixed for Eloquent, but is an ABI break so has not been backported to Dashing.
778778
* `[ros2/rclcpp#912] <https://github.com/ros2/rclcpp/issues/912>`_ Inter-process communication forces a message copy when intra-process communication takes place between an ``std::unique_ptr`` publisher and a single ``std::unique_ptr`` subscription (published ``std::unique_ptr`` is internally being promoted to an ``std::shared_ptr``).

source/Tutorials/Advanced/Recording-A-Bag-From-Your-Own-Node-CPP.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,7 @@ Now run the node:
482482
483483
ros2 run bag_recorder_nodes data_generator_node
484484
485-
Wait for 30 seconds or so, then terminate the node with ``ctrl-c``.
485+
Wait for 30 seconds or so, then terminate the node with :kbd:`ctrl-c`.
486486
Next, play back the created bag.
487487

488488
.. code-block:: console

source/Tutorials/Advanced/Recording-A-Bag-From-Your-Own-Node-Py.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -480,7 +480,7 @@ Now run the node:
480480
481481
ros2 run bag_recorder_nodes_py data_generator_node
482482
483-
Wait for 30 seconds or so, then terminate the node with ``ctrl-c``.
483+
Wait for 30 seconds or so, then terminate the node with :kbd:`ctrl-c`.
484484
Next, play back the created bag.
485485

486486
.. code-block:: console

source/Tutorials/Demos/Intra-Process-Communication.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ https://github.com/ros2/demos/blob/{REPOS_FILE_BRANCH}/intra_process_demo/src/cy
210210
reinterpret_cast<std::uintptr_t>(msg.get()));
211211
printf(" sleeping for 1 second...\n");
212212
if (!rclcpp::sleep_for(1s)) {
213-
return; // Return if the sleep failed (e.g. on ctrl-c).
213+
return; // Return if the sleep failed (e.g. on :kbd:`ctrl-c`).
214214
}
215215
printf(" done.\n");
216216
msg->data++; // Increment the message's data.

source/Tutorials/Intermediate/Launch/Using-Event-Handlers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ It means that the launch process will shutdown when the turtlesim window is clos
251251
252252
Finally, the ``OnShutdown`` event handler is used to register a callback function that is executed when the launch file is asked to shutdown.
253253
It logs a message to the console why the launch file is asked to shutdown.
254-
It logs the message with a reason for shutdown like the closure of turtlesim window or ``ctrl-c`` signal made by the user.
254+
It logs the message with a reason for shutdown like the closure of turtlesim window or :kbd:`ctrl-c` signal made by the user.
255255

256256
.. code-block:: python
257257

source/Tutorials/Intermediate/Rosdep.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ In general, there are two files of interest: ``rosdep/base.yaml`` and ``rosdep/p
7373
``base.yaml`` in general contains the ``apt`` system dependencies.
7474
``python.yaml`` in general contains the ``pip`` python dependencies.
7575

76-
To find a key, search for your library in this file (preferably ctrl+F, its long) and find the name in ``yaml`` that contains it.
76+
To find a key, search for your library in this file and find the name in ``yaml`` that contains it.
7777
This is the key to put in a ``package.xml`` file.
7878

7979
For example, imagine a package had a dependency on ``doxygen`` because it is a great piece of software that cares about quality documentation (hint hint).

0 commit comments

Comments
 (0)