Skip to content

docs: match :param names to the signatures in sensors and DHRobot #906

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

Merged
petercorke merged 2 commits into from
Nov 2, 2026
Merged

docs: match :param names to the signatures in sensors and DHRobot #906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bec2ebd
docs: match :param names to the signatures in sensors and DHRobot
mmporong Oct 27, 2026
fcf38c3
Merge branch 'main' into docs/param-names
petercorke Nov 2, 2026
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
12 changes: 6 additions & 6 deletions src/roboticstoolbox/mobile/sensors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -689,8 +689,8 @@ def Hx(self, x: ArrayLike, landmark: int | ArrayLike) -> NDArray:

:param x: vehicle state :math:`(x, y, \theta)`
:type x: array_like(3)
:param arg: landmark id or coordinate
:type arg: int or array_like(2)
:param landmark: landmark id or coordinate
:type landmark: int or array_like(2)
:return: Jacobian matrix
:rtype: ndarray(2,3)

Expand Down Expand Up @@ -725,8 +725,8 @@ def Hp(self, x: ArrayLike, landmark: int | ArrayLike) -> NDArray:

:param x: vehicle state :math:`(x, y, \theta)`
:type x: array_like(3)
:param arg: landmark id or coordinate
:type arg: int or array_like(2)
:param landmark: landmark id or coordinate
:type landmark: int or array_like(2)
:return: Jacobian matrix
:rtype: ndarray(2,2)

Expand Down Expand Up @@ -759,8 +759,8 @@ def Hw(self, x: ArrayLike, landmark: int | ArrayLike | None) -> NDArray:

:param x: vehicle state :math:`(x, y, \theta)`
:type x: array_like(3)
:param arg: landmark id or coordinate
:type arg: int or array_like(2)
:param landmark: landmark id or coordinate
:type landmark: int or array_like(2)
:return: Jacobian matrix
:rtype: ndarray(2,2)

Expand Down
4 changes: 2 additions & 2 deletions src/roboticstoolbox/robot/DHRobot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1294,8 +1294,8 @@ def config_validate(self, config: Any, allowables: Any) -> Any:

:param config: a configuration string
:type config: str
:param allowable: [description]
:type allowable: tuple of str
:param allowables: one string of valid characters per choice, default first
:type allowables: tuple of str
:raises ValueError: bad character in configuration string
:return: configuration string
:rtype: str
Expand Down
Loading