Skip to content

Commit 5697c2e

Browse files
committed
Clarification regarding weight in docstring
1 parent e04be13 commit 5697c2e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/compas_fab/robots/planning_scene.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,11 @@ class AttachedCollisionMesh(object):
8181
link_name : :obj:`str`
8282
The name of the :class:`~compas.robots.Link` the collision mesh will be
8383
attached to.
84-
touch_links : :obj:`list` of :obj:`str`
84+
touch_links : :obj:`list` of :obj:`str`, optional
8585
The list of link names the collision mesh is allowed to touch. Defaults
8686
to the link it is attached to.
87-
weight : :obj:`float`
88-
The weight of the attached object. Defaults to ``1.0``.
87+
weight : :obj:`float`, optional
88+
The weight of the attached object in kg. Defaults to ``1.0``.
8989
9090
Attributes
9191
----------
@@ -98,7 +98,7 @@ class AttachedCollisionMesh(object):
9898
The list of link names the collision mesh is allowed to touch. Defaults
9999
to the link it is attached to.
100100
weight : :obj:`float`
101-
The weight of the attached object. Defaults to ``1.0``.
101+
The weight of the attached object in kg.
102102
103103
Examples
104104
--------
@@ -129,7 +129,7 @@ class PlanningScene(object):
129129
----------
130130
robot : :class:`Robot`
131131
A reference to the robot in the planning scene.
132-
client : :class:`compas_fab.backend.RosClient` or :class:`compas_fab.backend.VrepClient`
132+
client
133133
A reference to the robot's backend client.
134134
"""
135135

@@ -212,12 +212,12 @@ def append_collision_mesh(self, collision_mesh, scale=False):
212212
"""Append a collision mesh to the planning scene.
213213
214214
Appends a :class:`CollisionMesh` to the :class:`PlanningScene` using
215-
``id`` as an identifier of a group or cluster of collision meshes. If the group
215+
`id` as an identifier of a group or cluster of collision meshes. If the group
216216
does not exist, it will be created implicitly; if it does exist, the meshes will be
217217
appended to it instead.
218-
218+
219219
Grouping meshes under a common identifier allows to remove them all
220-
in one operation, using the :meth:`~PlanningScene.remove_collision_mesh` with
220+
in one operation, using the :meth:`~PlanningScene.remove_collision_mesh` with
221221
the group identifier.
222222
223223
Parameters

0 commit comments

Comments
 (0)