Skip to content

Commit

Permalink
lint docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yck011522 committed Aug 9, 2024
1 parent 3e229fd commit 6128721
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ def set_robot_cell(self, robot_cell, robot_cell_state=None, options=None):
Note that the Analytical Planner does not support collision checking. Therefore, the
geometry of the robot, tools and rigid bodies in the robot cell are not checked.
Note
----
Notes
-----
The robot_cell_state and options are not used in this implementation.
"""
Expand Down
10 changes: 4 additions & 6 deletions src/compas_fab/backends/pybullet/backend_features/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,12 @@
:toctree: generated/
:nosignatures:
PyBulletAddAttachedCollisionMesh
PyBulletAddCollisionMesh
PyBulletAppendCollisionMesh
PyBulletCheckCollision
PyBulletForwardKinematics
PyBulletInverseKinematics
PyBulletRemoveAttachedCollisionMesh
PyBulletRemoveCollisionMesh
PyBulletPlanCartesianMotion
PyBulletSetRobotCell
PyBulletSetRobotCellState
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ def iter_inverse_kinematics_frame_target(self, target, robot_cell_state=None, gr
# type: (FrameTarget, Optional[RobotCellState], Optional[str], Optional[Dict]) -> Generator[Tuple[List[float], List[str]], None, None]
"""Calculate the robot's inverse kinematic for a given frame.
Note
----
Notes
-----
The planner will make multiple attempts to find a solution.
The number of attempts is determined by the ``max_results`` option.
The planner is a gradient descent solver, so the initial position of the robot is important.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ def set_robot_cell_state(self, robot_cell_state):
The robot cell state must match the robot cell set earlier by :meth:`set_robot_cell`.
Note
----
Notes
-----
All the magic for transforming the attached objects happens here.
"""
client = self.client # type: PyBulletClient # Trick to keep intellisense happy
Expand Down
4 changes: 2 additions & 2 deletions src/compas_fab/backends/pybullet/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -414,8 +414,8 @@ def robot_model_to_urdf(self, robot_model, concavity=False):
convex hull for collision checking purposes. When ``True``,
a non-static mesh will be decomposed into convex parts using v-HACD.
Return
------
Returns
-------
:obj:`str`
The file path to the robot model URDF package.
Expand Down

0 comments on commit 6128721

Please sign in to comment.