Skip to content

Commit

Permalink
Document parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderFabisch committed Jul 14, 2023
1 parent 08b60e2 commit f7a2018
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion pytransform3d/transform_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,19 @@


class TransformGraphBase(abc.ABC):
"""Base class for all trees of rigid transformations."""
"""Base class for all trees of rigid transformations.
Parameters
----------
strict_check : bool, optional (default: True)
Raise a ValueError if the transformation matrix is not numerically
close enough to a real transformation matrix. Otherwise we print a
warning.
check : bool, optional (default: True)
Check if transformation matrices are valid and requested nodes exist,
which might significantly slow down some operations.
"""
def __init__(self, strict_check=True, check=True):
self.strict_check = strict_check
self.check = check
Expand Down

0 comments on commit f7a2018

Please sign in to comment.