Skip to content

Commit e433b09

Browse files
authored
docs: update document for typing (#172)
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
1 parent c16a7a2 commit e433b09

4 files changed

Lines changed: 8 additions & 4 deletions

File tree

docs/apis/dataclass.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@
1515
options:
1616
show_bases: false
1717

18-
::: t4_devkit.dataclass.roi
19-
2018
::: t4_devkit.dataclass.shape
2119

2220
::: t4_devkit.dataclass.trajectory

docs/apis/typing.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# `typing`
2+
3+
<!-- prettier-ignore-start -->
4+
::: t4_devkit.typing
5+
<!-- prettier-ignore-end -->

mkdocs.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ nav:
2727
- t4_devkit.dataclass: apis/dataclass.md
2828
- t4_devkit.filtering: apis/filtering.md
2929
- t4_devkit.viewer: apis/viewer.md
30+
- t4_devkit.typing: apis/typing.md
3031
- t4_devkit.common: apis/common.md
3132

3233
theme:

t4_devkit/dataclass/transform.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -459,12 +459,12 @@ def _format_transform_args(*args, **kwargs) -> dict[str, Any]:
459459

460460

461461
def _extract_position_and_rotation_from_matrix(
462-
matrix: NDArray | HomogeneousMatrix,
462+
matrix: Matrix4x4Like | HomogeneousMatrix,
463463
) -> tuple[Vector3, Quaternion]:
464464
"""Extract position and rotation from a homogeneous matrix.
465465
466466
Args:
467-
matrix (NDArray | HomogeneousMatrix): 4x4 matrix or `HomogeneousMatrix` object.
467+
matrix (Matrix4x4Like | HomogeneousMatrix): 4x4 matrix or `HomogeneousMatrix` object.
468468
469469
Raises:
470470
ValueError: Matrix shape must be 4x4.

0 commit comments

Comments
 (0)