From a4325d96ca9c56bc46241f0c455a55a2c655465c Mon Sep 17 00:00:00 2001 From: ktro2828 Date: Thu, 21 Aug 2025 20:25:09 +0900 Subject: [PATCH] docs: update document for typing Signed-off-by: ktro2828 --- docs/apis/dataclass.md | 2 -- docs/apis/typing.md | 5 +++++ mkdocs.yaml | 1 + t4_devkit/dataclass/transform.py | 4 ++-- 4 files changed, 8 insertions(+), 4 deletions(-) create mode 100644 docs/apis/typing.md diff --git a/docs/apis/dataclass.md b/docs/apis/dataclass.md index 4c3127a..0a32ac2 100644 --- a/docs/apis/dataclass.md +++ b/docs/apis/dataclass.md @@ -15,8 +15,6 @@ options: show_bases: false -::: t4_devkit.dataclass.roi - ::: t4_devkit.dataclass.shape ::: t4_devkit.dataclass.trajectory diff --git a/docs/apis/typing.md b/docs/apis/typing.md new file mode 100644 index 0000000..e2b1866 --- /dev/null +++ b/docs/apis/typing.md @@ -0,0 +1,5 @@ +# `typing` + + +::: t4_devkit.typing + diff --git a/mkdocs.yaml b/mkdocs.yaml index 9c1f950..b55c3ba 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -27,6 +27,7 @@ nav: - t4_devkit.dataclass: apis/dataclass.md - t4_devkit.filtering: apis/filtering.md - t4_devkit.viewer: apis/viewer.md + - t4_devkit.typing: apis/typing.md - t4_devkit.common: apis/common.md theme: diff --git a/t4_devkit/dataclass/transform.py b/t4_devkit/dataclass/transform.py index 996f27d..5382b32 100644 --- a/t4_devkit/dataclass/transform.py +++ b/t4_devkit/dataclass/transform.py @@ -459,12 +459,12 @@ def _format_transform_args(*args, **kwargs) -> dict[str, Any]: def _extract_position_and_rotation_from_matrix( - matrix: NDArray | HomogeneousMatrix, + matrix: Matrix4x4Like | HomogeneousMatrix, ) -> tuple[Vector3, Quaternion]: """Extract position and rotation from a homogeneous matrix. Args: - matrix (NDArray | HomogeneousMatrix): 4x4 matrix or `HomogeneousMatrix` object. + matrix (Matrix4x4Like | HomogeneousMatrix): 4x4 matrix or `HomogeneousMatrix` object. Raises: ValueError: Matrix shape must be 4x4.