minor: Use single backticks for inline command-line instructions

Author: stephane-caron

CHANGELOG.md

@@ -9,6 +9,10 @@ All notable changes to this project will be documented in this file.
 - Description: AgileX PiPER
 - Description: Robotiq 2F-85 (MJCF V4) (thanks to @peterdavidfagan)
 
+### Fixed
+
+- minor: Use single backticks for inline command-line instructions
+
 ## [1.14.0] - 2025-01-07
 
 ### Added

examples/load_in_idyntree.py

@@ -8,7 +8,7 @@
 Load a robot description, specified from the command line, in iDynTree.
 
 This example requires iDynTree, which can be installed by
-``conda install -c conda-forge idyntree``.
+`conda install -c conda-forge idyntree`.
 """
 
 import argparse

examples/load_in_mujoco.py

@@ -7,7 +7,7 @@
 """
 Show a robot description, specified from the command line, in MuJoCo.
 
-This example requires MuJoCo, which is installed by ``pip install mujoco``.
+This example requires MuJoCo, which is installed by `pip install mujoco`.
 """
 
 import argparse

examples/load_in_pinocchio.py

@@ -7,7 +7,7 @@
 """
 Load a robot description, specified from the command line, in Pinocchio.
 
-This example requires Pinocchio, which is installed by ``pip install pin``.
+This example requires Pinocchio, installed by e.g. `conda install pinocchio`.
 """
 
 import argparse

examples/load_in_pybullet.py

@@ -7,7 +7,7 @@
 """
 Load a robot description, specified from the command line, in PyBullet.
 
-This example requires PyBullet, which is installed by ``pip install pybullet``.
+This example requires PyBullet, which is installed by `pip install pybullet`.
 """
 
 import argparse

examples/load_in_yourdfpy.py

@@ -7,7 +7,7 @@
 """
 Load a robot description, specified from the command line, using yourdfpy.
 
-This example requires yourdfpy, which is installed by ``pip install yourdfpy``.
+This example requires yourdfpy, which is installed by `pip install yourdfpy`.
 """
 
 import argparse

examples/show_in_mujoco.py

@@ -7,8 +7,8 @@
 """
 Show a robot description, specified from the command line, using MuJoCo.
 
-This example requires MuJoCo, which is installed by ``pip install mujoco``, and
-the MuJoCo viewer installed by ``pip install mujoco-python-viewer``.
+This example requires MuJoCo, which is installed by `pip install mujoco`, and
+the MuJoCo viewer installed by `pip install mujoco-python-viewer`.
 """
 
 import argparse
@@ -19,7 +19,7 @@
     import mujoco_viewer
 except ImportError as e:
     raise ImportError(
-        "MuJoCo viewer not found, " "try ``pip install mujoco-python-viewer``"
+        "MuJoCo viewer not found, " "try `pip install mujoco-python-viewer`"
     ) from e
 
 from robot_descriptions.loaders.mujoco import load_robot_description

examples/specific_commit.py

@@ -6,9 +6,9 @@
 
 """
 We can load specific commit to pin the version of any robot description using
-the ``commit`` keyword argument. In this example, we load a Universal Robots
-UR5e from a specific commit of the MuJoCo Menagerie repository that distributes
-it. This example requires MuJoCo, which is installed by ``pip install mujoco``.
+the `commit` keyword argument. In this example, we load a Universal Robots UR5e
+from a specific commit of the MuJoCo Menagerie repository that distributes it.
+This example requires MuJoCo, which is installed by `pip install mujoco`.
 
 See also:
     https://github.com/robot-descriptions/robot_descriptions.py/discussions/86

robot_descriptions/_command_line.py

@@ -115,15 +115,15 @@ def show(
     if not hasattr(module, "URDF_PATH"):
         raise ValueError(
             "show command only applies to URDF, check out the "
-            "``show_in_mujoco.py`` example for MJCF descriptions"
+            "`show_in_mujoco.py` example for MJCF descriptions"
         )
 
     try:
         yourdfpy = import_module("yourdfpy")
     except ModuleNotFoundError as exc:
         raise ValueError(
             "This command requires yourdfpy. You can installed it by: "
-            "``pip install yourdfpy``"
+            "`pip install yourdfpy`"
         ) from exc
 
     if collision:

robot_descriptions/loaders/yourdfpy.py

@@ -16,7 +16,7 @@
 except ModuleNotFoundError as e:
     raise ModuleNotFoundError(
         "This feature requires 'yourdfpy', "
-        "which can be installed by ``pip install yourdfpy``"
+        "which can be installed by `pip install yourdfpy`"
     ) from e