Skip to content

Commit 1c58615

Browse files
committed
Attributes should not be marked as optional
1 parent 1a32b5b commit 1c58615

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

src/compas_fab/robots/constraints.py

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -185,10 +185,9 @@ class Constraint(object):
185185
----------
186186
constraint_type
187187
Constraint type, one of :attr:`Constraint.CONSTRAINT_TYPES`.
188-
weight : :obj:`float`, optional
188+
weight : :obj:`float`
189189
A weighting factor for this constraint. Denotes relative importance to
190-
other constraints. Closer to zero means less important. Defaults to
191-
``1``.
190+
other constraints. Closer to zero means less important.
192191
193192
Class Attributes
194193
----------------
@@ -274,13 +273,12 @@ class JointConstraint(Constraint):
274273
value : :obj:`float`
275274
The targeted value for that joint.
276275
tolerance_above : :obj:`float`
277-
Tolerance above the targeted joint value, in radians. Defaults to ``0``.
276+
Tolerance above the targeted joint value, in radians.
278277
tolerance_below : :obj:`float`
279-
Tolerance below the targeted joint value, in radians. Defaults to ``0``.
280-
weight : :obj:`float`, optional
278+
Tolerance below the targeted joint value, in radians.
279+
weight : :obj:`float`
281280
A weighting factor for this constraint. Denotes relative importance to
282-
other constraints. Closer to zero means less important. Defaults to
283-
``1``.
281+
other constraints. Closer to zero means less important.
284282
285283
Examples
286284
--------
@@ -349,15 +347,13 @@ class OrientationConstraint(Constraint):
349347
quaternion : :obj:`list` of :obj:`float`
350348
The desired orientation of the link specified by a quaternion in the
351349
order of ``[w, x, y, z]``.
352-
tolerances : :obj:`list` of :obj:`float`, optional
350+
tolerances : :obj:`list` of :obj:`float`
353351
Error tolerances t\ :sub:`i` for each of the frame's axes. If only one
354352
value is passed it will be used for all 3 axes. The respective bound to
355-
be achieved is :math:`(a_{i} - t_{i}, a_{i} + t_{i})`. Defaults to
356-
``[0.01, 0.01, 0.01]``.
357-
weight : :obj:`float`, optional
353+
be achieved is :math:`(a_{i} - t_{i}, a_{i} + t_{i})`.
354+
weight : :obj:`float`
358355
A weighting factor for this constraint. Denotes relative importance to
359-
other constraints. Closer to zero means less important. Defaults to
360-
``1``.
356+
other constraints. Closer to zero means less important.
361357
362358
Notes
363359
-----
@@ -429,10 +425,9 @@ class PositionConstraint(Constraint):
429425
The name of the link this contraint refers to.
430426
bounding_volume : :class:`BoundingVolume`
431427
The volume this constraint refers to.
432-
weight : :obj:`float`, optional
428+
weight : :obj:`float`
433429
A weighting factor for this constraint. Denotes relative importance to
434-
other constraints. Closer to zero means less important. Defaults to
435-
``1``.
430+
other constraints. Closer to zero means less important.
436431
437432
Examples
438433
--------

0 commit comments

Comments
 (0)