Skip to content

Commit 74cac6a

Browse files
Release v1.4.0
1 parent 2bab5e9 commit 74cac6a

File tree

3 files changed

+13
-12
lines changed

3 files changed

+13
-12
lines changed

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22

33
All notable changes to this project will be documented in this file.
44

5-
## Unreleased
5+
## [1.4.0] - 2023/2/8
66

77
### Added
88

9+
- Ability to load a robot description at a specific commit
910
- Example: display all frames of a URDF description
1011

1112
### Fixed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,15 @@ pip install robot_descriptions
1717

1818
## Usage
1919

20-
The library provides a `load_robot_description` function for each of the following robotics software:
20+
The library provides `load_robot_description` functions that, given a description name, return an instance directly usable in the corresponding robotics software. For example:
21+
22+
```python
23+
from robot_descriptions.loaders.pinocchio import load_robot_description
24+
25+
robot = load_robot_description("upkie_description")
26+
```
27+
28+
Loaders are implemented for each of the following robotics software:
2129

2230
| Software | Loader |
2331
|-------------|------------------------------------------|
@@ -28,15 +36,7 @@ The library provides a `load_robot_description` function for each of the followi
2836
| RoboMeshCat | `robot_descriptions.loaders.robomeshcat` |
2937
| yourdfpy | `robot_descriptions.loaders.yourdfpy` |
3038

31-
The function loads a robot description from its name, and returns an instance directly usable in the target software. For example:
32-
33-
```python
34-
from robot_descriptions.loaders.pinocchio import load_robot_description
35-
36-
robot = load_robot_description("upkie_description")
37-
```
38-
39-
Loading will automatically download the robot description if you don't have it already, and cache it to a local directory.
39+
Loading will automatically download the robot description if needed, and cache it to a local directory.
4040

4141
### Import as submodule
4242

robot_descriptions/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@
1919
Import open source robot description as Python modules.
2020
"""
2121

22-
__version__ = "1.4.0rc0"
22+
__version__ = "1.4.0"

0 commit comments

Comments
 (0)