Skip to content

docs: update document for typing #172

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
ktro2828 merged 1 commit into from
Aug 21, 2025
Merged

docs: update document for typing #172

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
2 changes: 0 additions & 2 deletions docs/apis/dataclass.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@
options:
show_bases: false

::: t4_devkit.dataclass.roi

::: t4_devkit.dataclass.shape

::: t4_devkit.dataclass.trajectory
Expand Down
5 changes: 5 additions & 0 deletions docs/apis/typing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# `typing`

<!-- prettier-ignore-start -->
::: t4_devkit.typing
<!-- prettier-ignore-end -->
1 change: 1 addition & 0 deletions mkdocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions t4_devkit/dataclass/transform.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading