Skip to content

Commit 3f3cb89

Browse files
committed
📚 Improve documentation
1 parent 3c0a51e commit 3f3cb89

3 files changed

Lines changed: 7 additions & 7 deletions

File tree

docs/src/man/dcm.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ with the reference frame ``b`` is:
2525
In **ReferenceFrameRotations.jl**, a DCM is a ``3 \times 3`` static matrix:
2626

2727
```julia
28-
DCM{T} = SMatrix{3,3,T,9}
28+
DCM{T} = SMatrix{3, 3, T, 9}
2929
```
3030

3131
which means that `DCM` is immutable.
@@ -125,15 +125,15 @@ julia> orthonormalize(D)
125125
0.0 1.0 0.0
126126
0.0 0.0 1.0
127127
128-
julia> D = DCM(1,1,2,2,3,3,4,4,5);
128+
julia> D = DCM(1, 1, 2, 2, 3, 3, 4, 4, 5);
129129
130130
julia> Dn = orthonormalize(D)
131131
3×3 StaticArrays.SMatrix{3, 3, Float64, 9} with indices SOneTo(3)×SOneTo(3):
132132
0.408248 0.123091 0.904534
133133
0.408248 0.86164 -0.301511
134134
0.816497 -0.492366 -0.301511
135135
136-
julia> Dn*Dn'
136+
julia> Dn * Dn'
137137
3×3 StaticArrays.SMatrix{3, 3, Float64, 9} with indices SOneTo(3)×SOneTo(3):
138138
1.0 -2.87528e-16 -8.47673e-16
139139
-2.87528e-16 1.0 3.31283e-16

docs/src/man/euler_angle_axis.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,12 @@ the Euler angle of the result will always be in the interval ``[0, \pi]`` rad.
7878
normalize the vector.
7979

8080
```jldoctest
81-
julia> ea1 = EulerAngleAxis(30 * pi / 180, [1.0;0.0;0.0])
81+
julia> ea1 = EulerAngleAxis(30 * pi / 180, [1.0, 0.0, 0.0])
8282
EulerAngleAxis{Float64}:
8383
Euler angle : 0.523599 rad (30.0°)
8484
Euler axis : [1.0, 0.0, 0.0]
8585
86-
julia> ea2 = EulerAngleAxis(60 * pi / 180, [1.0;0.0;0.0])
86+
julia> ea2 = EulerAngleAxis(60 * pi / 180, [1.0, 0.0, 0.0])
8787
EulerAngleAxis{Float64}:
8888
Euler angle : 1.0472 rad (60.0°)
8989
Euler axis : [1.0, 0.0, 0.0]

docs/src/man/quaternions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ julia> inv(q) # Computes the multiplicative inverse of the quaternion.
388388
Quaternion{Float64}:
389389
+ 0.0333333 - 0.0666667⋅i - 0.1⋅j - 0.133333⋅k
390390
391-
julia> inv(q)*q
391+
julia> inv(q) * q
392392
Quaternion{Float64}:
393393
+ 1.0 + 0.0⋅i + 5.55112e-17⋅j + 0.0⋅k
394394
@@ -413,7 +413,7 @@ julia> vect(q) # Returns the vectorial / imaginary part of the quaternion.
413413

414414
!!! note
415415

416-
The operation `a/q` is equal to `a*inv(q)` if `a` is a scalar.
416+
The operation `a / q` is equal to `a * inv(q)` if `a` is a scalar.
417417

418418
### Converting reference frames using quaternions
419419

0 commit comments

Comments
 (0)