Add keyboard markup (#3695) (#3698)

* add keyboard markup Co-authored-by: Chris Lalancette <[email protected]> (cherry picked from commit 6de7fb9) Co-authored-by: Cristian Chitiva <[email protected]>
ros2 · May 30, 2023 · 18dad5c · 18dad5c
1 parent d8164c9
commit 18dad5c
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 5 deletions.
diff --git a/source/Releases/Release-Dashing-Diademata.rst b/source/Releases/Release-Dashing-Diademata.rst
@@ -772,7 +772,7 @@ Known Issues
 
 * `[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.
   Currently available workarounds are noted in an `issue comment <https://github.com/ros2/rclcpp/issues/715#issuecomment-497392626>`_
-* `[ros2/rclpy#360] <https://github.com/ros2/rclpy/issues/360>`_ rclpy nodes ignore ``ctrl-c`` when using OpenSplice on Windows.
+* `[ros2/rclpy#360] <https://github.com/ros2/rclpy/issues/360>`_ rclpy nodes ignore :kbd:`ctrl-c` when using OpenSplice on Windows.
 * `[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.
 * `[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.
 * `[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``).

diff --git a/source/Tutorials/Advanced/Recording-A-Bag-From-Your-Own-Node-CPP.rst b/source/Tutorials/Advanced/Recording-A-Bag-From-Your-Own-Node-CPP.rst
@@ -648,7 +648,7 @@ Now run the node:
 
     ros2 run bag_recorder_nodes data_generator_node
 
-Wait for 30 seconds or so, then terminate the node with ``ctrl-c``.
+Wait for 30 seconds or so, then terminate the node with :kbd:`ctrl-c`.
 Next, play back the created bag.
 
 .. code-block:: console

diff --git a/source/Tutorials/Demos/Intra-Process-Communication.rst b/source/Tutorials/Demos/Intra-Process-Communication.rst
@@ -210,7 +210,7 @@ https://github.com/ros2/demos/blob/{REPOS_FILE_BRANCH}/intra_process_demo/src/cy
              reinterpret_cast<std::uintptr_t>(msg.get()));
            printf("  sleeping for 1 second...\n");
            if (!rclcpp::sleep_for(1s)) {
-             return;    // Return if the sleep failed (e.g. on ctrl-c).
+             return;    // Return if the sleep failed (e.g. on :kbd:`ctrl-c`).
            }
            printf("  done.\n");
            msg->data++;    // Increment the message's data.

diff --git a/source/Tutorials/Intermediate/Launch/Using-Event-Handlers.rst b/source/Tutorials/Intermediate/Launch/Using-Event-Handlers.rst
@@ -251,7 +251,7 @@ It means that the launch process will shutdown when the turtlesim window is clos
 
 Finally, the ``OnShutdown`` event handler is used to register a callback function that is executed when the launch file is asked to shutdown.
 It logs a message to the console why the launch file is asked to shutdown.
-It logs the message with a reason for shutdown like the closure of turtlesim window or ``ctrl-c`` signal made by the user.
+It logs the message with a reason for shutdown like the closure of turtlesim window or :kbd:`ctrl-c` signal made by the user.
 
 .. code-block:: python
 

diff --git a/source/Tutorials/Intermediate/Rosdep.rst b/source/Tutorials/Intermediate/Rosdep.rst
@@ -73,7 +73,7 @@ In general, there are two files of interest: ``rosdep/base.yaml`` and ``rosdep/p
 ``base.yaml`` in general contains the ``apt`` system dependencies.
 ``python.yaml`` in general contains the ``pip`` python dependencies.
 
-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.
+To find a key, search for your library in this file and find the name in ``yaml`` that contains it.
 This is the key to put in a ``package.xml`` file.
 
 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).