Skip to content

Commit 49d14ac

Browse files
committed
clarify docstring
1 parent 7284a05 commit 49d14ac

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/orientation.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,9 @@ end
113113
`R21` is a 3x3 matrix that transforms a vector from frame 1 to frame 2. `h1` is a
114114
vector resolved in frame 1. `h2` is the same vector in frame 2.
115115
116-
Typical usage:
116+
Typical usage (world to local):
117117
```julia
118-
resolve2(ori(frame_a), a_0 - g_0)
118+
g_a = resolve2(ori(frame_a), a_0 - g_0)
119119
```
120120
"""
121121
resolve2(R21::RotationMatrix, v1) = R21 * collect(v1)
@@ -126,9 +126,9 @@ resolve2(R21::RotationMatrix, v1) = R21 * collect(v1)
126126
`R12` is a 3x3 matrix that transforms a vector from frame 1 to frame 2. `h2` is a
127127
vector resolved in frame 2. `h1` is the same vector in frame 1.
128128
129-
Typical usage:
129+
Typical usage (local to world):
130130
```julia
131-
resolve1(ori(frame_a), r_ab)
131+
r_wb = resolve1(ori(frame_a), r_ab)
132132
```
133133
"""
134134
resolve1(R21::RotationMatrix, v2) = R21'collect(v2)

0 commit comments

Comments
 (0)