Skip to content

Commit 064b2f4

Browse files
committed
simplify docstring
1 parent 67f745c commit 064b2f4

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/src/rotations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ A [quaternion](https://en.wikipedia.org/wiki/Quaternion) represents an orientati
1212

1313
[^quat]: "Integrating Rotations using Non-Unit Quaternions", Caleb Rucker, https://par.nsf.gov/servlets/purl/10097724
1414

15-
Multibody.jl depends on [Rotations.jl](https://github.com/JuliaGeometry/Rotations.jl) which in turn uses [Quaternions.jl](https://github.com/JuliaGeometry/Quaternions.jl) for quaternion computations. If you manually create quaternions using these packages, you may convert them to a vector to provide, e.g., initial conditions, using `Rotations.params(Q)` (see [Conversion between formats](@ref) below).
15+
Multibody.jl depends on [Rotations.jl](https://github.com/JuliaGeometry/Rotations.jl) which in turn uses [Quaternions.jl](https://github.com/JuliaGeometry/Quaternions.jl) for quaternion computations. If you manually create quaternions using these packages, you may convert them to a vector to provide, e.g., initial conditions, using `Rotations.params(Q)` (see [Conversion between orientation formats](@ref) below).
1616

1717
### Examples using quaternions
1818
- [Free motions](@ref) (second example on the page)
@@ -23,7 +23,7 @@ Multibody.jl depends on [Rotations.jl](https://github.com/JuliaGeometry/Rotation
2323
Rotation matrices represent orientation using a ``3\times 3`` matrix ``\in SO(3)``. These are used in the equations of multibody components and connectors, but should for the most part be invisible to the user. In particular, they should never appear as state variables after simplification.
2424

2525

26-
## Conversion between formats
26+
## Conversion between orientation formats
2727
You may convert between different representations of orientation using the appropriate constructors from Rotations.jl, for example:
2828
```@example ORI
2929
using Multibody.Rotations

src/components.jl

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -141,18 +141,18 @@ Can be thought of as a massless rod. For a massive rod, see [`BodyShape`](@ref)
141141
end
142142

143143
"""
144-
FixedRotation(; name, r, n, sequence, isroot = false, angle, n_x, n_y)
144+
FixedRotation(; name, r, n, sequence, isroot = false, angle)
145145
146146
Fixed translation followed by a fixed rotation of `frame_b` with respect to `frame_a`
147147
148-
149148
- `r`: Translation vector
150149
- `n`: Axis of rotation, resolved in frame_a
151-
- `sequence`: DESCRIPTION
152150
- `angle`: Angle of rotation around `n`, given in radians
151+
152+
To obtain an axis-angle representation of any rotation, see [Conversion between orientation formats](@ref)
153153
"""
154-
@component function FixedRotation(; name, r=[0, 0, 0], n = [1, 0, 0], sequence = [1, 2, 3], isroot = false,
155-
angle, n_x = [1, 0, 0], n_y = [0, 1, 0])
154+
@component function FixedRotation(; name, r=[0, 0, 0], n = [1, 0, 0], isroot = false,
155+
angle)
156156
norm(n) 1 || error("n must be a unit vector")
157157
@named frame_a = Frame()
158158
@named frame_b = Frame()

0 commit comments

Comments
 (0)