Skip to content

Commit

Permalink
clarify docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
baggepinnen committed Aug 28, 2024
1 parent 7284a05 commit 49d14ac
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/orientation.jl
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,9 @@ end
`R21` is a 3x3 matrix that transforms a vector from frame 1 to frame 2. `h1` is a
vector resolved in frame 1. `h2` is the same vector in frame 2.
Typical usage:
Typical usage (world to local):
```julia
resolve2(ori(frame_a), a_0 - g_0)
g_a = resolve2(ori(frame_a), a_0 - g_0)
```
"""
resolve2(R21::RotationMatrix, v1) = R21 * collect(v1)
Expand All @@ -126,9 +126,9 @@ resolve2(R21::RotationMatrix, v1) = R21 * collect(v1)
`R12` is a 3x3 matrix that transforms a vector from frame 1 to frame 2. `h2` is a
vector resolved in frame 2. `h1` is the same vector in frame 1.
Typical usage:
Typical usage (local to world):
```julia
resolve1(ori(frame_a), r_ab)
r_wb = resolve1(ori(frame_a), r_ab)
```
"""
resolve1(R21::RotationMatrix, v2) = R21'collect(v2)
Expand Down

0 comments on commit 49d14ac

Please sign in to comment.