Fix documentation for transformation matrix references#5819
Conversation
Updated description for frame transformation: T_AB = "from frame B to A", NOT "from frame A to B" Signed-off-by: Junette Hsin <junetter@gmail.com>
Greptile SummaryThis PR corrects docstring descriptions in
Confidence Score: 5/5Documentation-only change with no effect on runtime behavior; both corrections are mathematically verified against the implementations. The two changed lines fix docstring descriptions that were the inverse of what the code actually does. The corrected wording 'from frame B to A' matches the standard robotics pose convention used throughout the file (T_AB = pose of B in A), the composition formula T_02 = T_01 × T_12, and the explicit parameter descriptions. No logic or API surface is touched. No files require special attention; the single changed file has a clean, minimal correction. Important Files Changed
Sequence DiagramsequenceDiagram
participant F2 as Frame 2
participant F1 as Frame 1
participant F0 as Frame 0
Note over F2,F0: combine_frame_transforms: T02 = T01 x T12
F2->>F1: T12 (from frame 2 to frame 1)
F1->>F0: T01 (from frame 1 to frame 0)
Note over F2,F0: T_AB transforms a point FROM frame B TO frame A
Note over F2,F0: subtract_frame_transforms: T12 = T01inv x T02
F2->>F0: T02 (from frame 2 to frame 0)
F0->>F1: T01inv (from frame 0 to frame 1)
Reviews (1): Last reviewed commit: "Fix documentation for transformation mat..." | Re-trigger Greptile |
# Description
Updates the transformation-matrix docstrings in
`combine_frame_transforms()` and `subtract_frame_transforms()` on
`develop` to state that `T_{AB}` maps from frame B to frame A, matching
#5819 on `main`.
No new dependencies.
Fixes # N/A - follow-up to #5819 for `develop`.
## Type of change
- Documentation update
## Screenshots
Not applicable.
## Checklist
- [x] I have read and understood the [contribution
guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html)
- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format` (`./isaaclab.sh -f`; all hooks pass except
`check-git-lfs-pointers`, which fails because `git-lfs` is not installed
locally)
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works (not applicable: docstring-only change)
- [x] I have added a changelog fragment under
`source/<pkg>/changelog.d/` for every touched package
(`source/isaaclab/changelog.d/antoiner-fix-transform-docs-develop.skip`)
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there (`Antoine Richard`)
Signed-off-by: Junette Hsin <junetter@gmail.com>
Co-authored-by: Junette Hsin <junetter@gmail.com>
Updated description for correct frame transformation: T_AB = "from frame B to A" (old: "from frame A to B") .
Description
Updated docstring text for
combine_frame_transformationsandsubtract_frame_transformationsinsideisaaclab.utils.math, specifically this misleading part:In the corrected description, A and B are swapped:
Fixes #5772.
Type of change
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists thereLeft pre-commit, test, changelog, and CONTRIBUTORS.md boxes unchecked because this is a minor docstring text correction.