Skip to content

Fix :param names in Twist3.UnitRevolute, Twist3.exp and Line2.contains #277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mmporong wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix :param names in Twist3.UnitRevolute, Twist3.exp and Line2.contains #277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions spatialmath/geom2d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,8 @@ def contains(self, p: ArrayLike2, tol: float = 20) -> bool:
"""
Test if point is in line

:param p1: point to test
:type p1: array_like(2) or array_like(3)
:param p: point to test
:type p: array_like(2) or array_like(3)
:param tol: tolerance in units of eps, defaults to 20
:type tol: float
:return: True if point lies in the line
Expand Down
8 changes: 4 additions & 4 deletions spatialmath/twist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,8 +483,8 @@ def UnitRevolute(cls, a, q, pitch=None):
:type a: array_like(3)
:param q: Point on the line of action
:type q: array_like(3)
:param p: pitch, defaults to None
:type p: float, optional
:param pitch: pitch, defaults to None
:type pitch: float, optional
:return: a rotational or helical twist
:rtype: Twist instance

Expand Down Expand Up @@ -1030,8 +1030,8 @@ def exp(self, theta=1, unit="rad"):

:param theta: rotation magnitude, defaults to None
:type theta: float, optional
:param units: rotational units, defaults to 'rad'
:type units: str, optional
:param unit: rotational units, defaults to 'rad'
:type unit: str, optional
:return: SE(3) matrix
:rtype: SE3 instance

Expand Down