8000 Polish docs · navrobot/robotics-toolbox-python@5020c42 · GitHub
[go: up one dir, main page]
Skip to content

Commit 5020c42

Browse files
petercorkepetercorke
committed
Polish docs
for Robot, Link classes
1 parent 6c533ef commit 5020c42

File tree

5 files changed

+479
-78
lines changed

5 files changed

+479
-78
lines changed

‎docs/source/arm.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@ Manipulator arms
88
arm_dh
99
arm_ets
1010
arm_urdf
11+
arm_superclass
1112
arm_backend
1213
arm_trajectory

‎docs/source/arm_superclass.rst

Lines changed: 34 additions & 0 deletions
+
:top-classes: roboticstoolbox.robot.Link
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Superclasses
2+
============
3+
4+
5+
Robot
6+
-------
7+
8+
.. inheritance-diagram:: roboticstoolbox.ERobot
9+
:top-classes: roboticstoolbox.Robot
10+
:parts: 2
11+
12+
The various models :ref:`E Models` all subclass this class.
13+
14+
.. automodule:: roboticstoolbox.robot.Robot
15+
:members:
16+
:undoc-members:
17+
:show-inheritance:
18+
:inherited-members:
19+
:special-members: __getitem__
20+
21+
Link
22+
-------
23+
24+
The ``ERobot`` is defined by a tree of ``ELink`` subclass objects.
25+
26+
.. inheritance-diagram:: roboticstoolbox.Link
27
28+
:parts: 2
29+
30+
.. automodule:: roboticstoolbox.robot.Link
31+
:members:
32+
:undoc-members:
33+
:show-inheritance:
34+
:inherited-members:

‎roboticstoolbox/robot/DHLink.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,10 @@ def _sin(theta):
4141

4242
class DHLink(Link):
4343
"""
44-
A link superclass for all link types. A Link object holds all information
45-
related to a robot joint and link such as kinematics parameters,
46-
rigid-body inertial parameters, motor and transmission parameters.
44+
A link superclass for all robots defined using Denavit-Hartenberg notation.
45+
A Link object holds all information related to a robot joint and link such
46+
as kinematics parameters, rigid-body inertial parameters, motor and
47+
transmission parameters.
4748
4849
:param theta: kinematic: joint angle
4950
:type theta: float

0 commit comments

Comments
 (0)
0