Skip to content

Commit a66c917

Browse files
stephane-caronStéphane Caron
authored andcommitted
Add missing parameter documentation
1 parent cf54f20 commit a66c917

File tree

6 files changed

+16
-4
lines changed

6 files changed

+16
-4
lines changed

robot_descriptions/loaders/idyntree.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ def load_robot_description(
4040
considered in the model. If empty, the model will contain all the
4141
joints specified in the URDF, otherwise a reduced model containing
4242
only the specified joints is created.
43+
commit: If specified, check out that commit from the cloned robot
44+
description repository.
4345
4446
Returns:
4547
Identifier of the robot in iDynTree.

robot_descriptions/loaders/mujoco.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,14 @@
2626

2727

2828
def load_robot_description(
29-
description_name: str, commit: Optional[str] = None
29+
description_name: str, commit: Optional[str] = None,
3030
) -> mujoco.MjModel:
3131
"""Load a robot description in MuJoCo.
3232
3333
Args:
3434
description_name: Name of the robot description.
35+
commit: If specified, check out that commit from the cloned robot
36+
description repository.
3537
3638
Returns:
3739
Robot model for MuJoCo.

robot_descriptions/loaders/pinocchio.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ def load_robot_description(
5353
root_joint (optional): First joint of the kinematic chain, for example
5454
a free flyer between the floating base of a mobile robot and an
5555
inertial frame. Defaults to no joint, i.e., a fixed base.
56+
commit: If specified, check out that commit from the cloned robot
57+
description repository.
5658
5759
Returns:
5860
Robot model for Pinocchio.

robot_descriptions/loaders/pybullet.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,14 @@
2626

2727

2828
def load_robot_description(
29-
description_name: str, commit: Optional[str] = None
29+
description_name: str, commit: Optional[str] = None,
3030
) -> int:
3131
"""Load a robot description in PyBullet.
3232
3333
Args:
3434
description_name: Name of the robot description.
35+
commit: If specified, check out that commit from the cloned robot
36+
description repository.
3537
3638
Returns:
3739
Identifier of the robot in PyBullet.

robot_descriptions/loaders/robomeshcat.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,14 @@
3131

3232

3333
def load_robot_description(
34-
description_name: str, commit: Optional[str] = None
34+
description_name: str, commit: Optional[str] = None,
3535
) -> robomeshcat.Robot:
3636
"""Load a robot description in RoboMeshCat.
3737
3838
Args:
3939
description_name: Name of the robot description.
40+
commit: If specified, check out that commit from the cloned robot
41+
description repository.
4042
4143
Returns:
4244
Robot model for RoboMeshCat.

robot_descriptions/loaders/yourdfpy.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,14 @@
3232

3333

3434
def load_robot_description(
35-
description_name: str, commit: Optional[str] = None
35+
description_name: str, commit: Optional[str] = None,
3636
) -> yourdfpy.URDF:
3737
"""Load a robot description in yourdfpy.
3838
3939
Args:
4040
description_name: Name of the robot description.
41+
commit: If specified, check out that commit from the cloned robot
42+
description repository.
4143
4244
Returns:
4345
Robot model for yourdfpy.

0 commit comments

Comments
 (0)