Skip to content

Commit 6ee1b42

Browse files
minor: Use single backticks
1 parent 512b414 commit 6ee1b42

File tree

6 files changed

+15
-16
lines changed

6 files changed

+15
-16
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@ The goal of this project is to facilitate loading and sharing of robot descripti
77

88
- [Add a new robot description](#adding-a-new-robot-description)
99
- Raise any issue you find in a description, preferably directly in the description's repository (check out [`_repositories.py`](https://github.com/stephane-caron/robot_descriptions.py/blob/main/robot_descriptions/_repositories.py))
10-
- Make a standalone ``<robot_name>_description`` repository for a description embedded in one of the big framework repositories (Bullet, Drake, ...)
10+
- Make a standalone `<robot_name>_description` repository for a description embedded in one of the big framework repositories (Bullet, Drake, ...)
1111

1212
## Adding a new robot description
1313

1414
1. **License:** The robot description is distributed legally and under an open source license (permissive or copyleft).
15-
2. **Repository:** If needed, add the repository containing the new description to ``_repositories.py``.
15+
2. **Repository:** If needed, add the repository containing the new description to `_repositories.py`.
1616
- Use a specific git commit ID. This way the robot description will still work in the interval between a change in the file structure of the target repository and the corresponding update in `robot_descriptions`.
17-
3. **Submodule:** add a Python file for the robot descriptions to ``robot_descriptions/``.
18-
- The file name for the new submodule is ``<robot_name>_description.py`` in snake-case.
19-
- For example, the file name for the Kinova (maker) Gen2 (robot name) is ``gen2_description.py``.
20-
- Use the ``mj_description`` suffix for an MJCF description.
21-
4. **Listing:** Add the description metadata to the ``DESCRIPTIONS`` dictionary in ``_descriptions.py``.
17+
3. **Submodule:** add a Python file for the robot descriptions to `robot_descriptions/`.
18+
- The file name for the new submodule is `<robot_name>_description.py` in snake-case.
19+
- For example, the file name for the Kinova (maker) Gen2 (robot name) is `gen2_description.py`.
20+
- Use the `mj_description` suffix for an MJCF description.
21+
4. **Listing:** Add the description metadata to the `DESCRIPTIONS` dictionary in `_descriptions.py`.
2222
5. **README:** Document the description's submodule name in the Descriptions section of the [README](README.md).
2323
- Use an [SPDX License Identifier](https://spdx.org/licenses/) in the License column.
2424
6. **CHANGELOG:** Write down the new model at the top of the [changelog](CHANGELOG.md).
25-
7. **Testing:** Check that all unit tests are successful by ``tox``.
25+
7. **Testing:** Check that all unit tests are successful by `tox`.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Loading will automatically download the robot description if needed, and cache i
5454

5555
### Import as submodule
5656

57-
You can also import a robot description directly as a submodule of ``robot_descriptions``:
57+
You can also import a robot description directly as a submodule of `robot_descriptions`:
5858

5959
```python
6060
from robot_descriptions import my_robot_description
@@ -83,7 +83,7 @@ The import will automatically download the robot description if you don't have i
8383
</dd>
8484
</dl>
8585

86-
Some robot descriptions include additional fields. For instance, the ``iiwa14_description`` exports ``URDF_PATH_POLYTOPE_COLLISION`` with more detailed collision meshes.
86+
Some robot descriptions include additional fields. For instance, the `iiwa14_description` exports `URDF_PATH_POLYTOPE_COLLISION` with more detailed collision meshes.
8787

8888
## Examples
8989

examples/show_in_meshcat.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
try:
1717
from pinocchio.visualize import MeshcatVisualizer
1818
except ImportError as e:
19-
raise ImportError("Pinocchio not found, try ``pip install pin``") from e
19+
raise ImportError("Pinocchio not found, try `pip install pin`") from e
2020

2121
from robot_descriptions.loaders.pinocchio import load_robot_description
2222

examples/show_in_pybullet.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"""
88
Show a robot description, specified from the command line, using PyBullet.
99
10-
This example requires PyBullet, which is installed by ``pip install pybullet``.
10+
This example requires PyBullet, which is installed by `pip install pybullet`.
1111
"""
1212

1313
import argparse

examples/show_in_yourdfpy.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,12 @@
88
Show a robot description, specified from the command line, using yourdfpy.
99
1010
Note:
11-
See ``robot_descriptions/_command_line.py`` for a more advanced
12-
implementation, including the ability to set the robot configuration or
13-
show collision meshes.
11+
You can also use `python -m robot_descriptions show_in_yourdfpy` from the
12+
command line.
1413
1514
This example requires `yourdfpy` which is an optional dependency. It can be
1615
installed separately (``pip install yourdfpy``), or when robot descriptions are
17-
installed with optional dependencies ``pip install robot_descriptions[opts]``.
16+
installed with optional dependencies `pip install robot_descriptions[opts]`.
1817
"""
1918

2019
import argparse
File renamed without changes.

0 commit comments

Comments
 (0)