Skip to content

Commit aee554c

Browse files
GiulioRomualdiStéphane Caron
andcommitted
Improve documentation for the iDynTree loader
Co-authored-by: Stéphane Caron <stephane@scaron.info>
1 parent 800e73e commit aee554c

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

robot_descriptions/loaders/idyntree.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,16 @@ def load_robot_description(description_name: str,
3535
Args:
3636
description_name: Name of the robot description.
3737
joints_list: Optional parameter containing the list of the joints considered
38-
in the model. If empty the model will contain all the joints
38+
in the model. If empty, the model will contain all the joints
3939
specified in the urdf, otherwise a reduced model containing
4040
only the specified joints is created.
4141
4242
Returns:
4343
Identifier of the robot in iDynTree.
44+
45+
Raises:
46+
ValueError:
47+
If the description is not URDF, or iDynTree is unable to load it.
4448
"""
4549
module = import_module(f"robot_descriptions.{description_name}")
4650
if not hasattr(module, "URDF_PATH"):

0 commit comments

Comments
 (0)