Skip to content

Commit 16c4f54

Browse files
committed
improve docstrings
1 parent 90fc248 commit 16c4f54

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

src/body_aerodynamics.jl

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
Main structure for calculating aerodynamic properties of bodies.
55
66
# Fields
7-
- panels::Vector{Panel}: Vector of Panel structs
7+
- panels::Vector{Panel}: Vector of [Panel](@ref) structs
88
- wings::Vector{AbstractWing}: a vector of wings; a body can have multiple wings
9-
- `va`::Union{Nothing, MVec3}: A vector of the apparent wind speed
9+
- `va`::Union{Nothing, MVec3}: A vector of the apparent wind speed, see: [MVec3](@ref)
1010
- `omega`::Union{Nothing, MVec3}: A vector of the turn rate around the kite body axes
1111
- `gamma_distribution`::Union{Nothing, Vector{Float64}}: unclear, please defined
1212
- `alpha_uncorrected`::Union{Nothing, Vector{Float64}}: unclear, please define
@@ -647,6 +647,7 @@ end
647647
Set velocity array and update wake filaments.
648648
649649
# Arguments
650+
- body_aero::BodyAerodynamics: The [BodyAerodynamics](@ref) struct to modify
650651
- `va`: Either a velocity vector or a list of velocity vectors
651652
- `omega`: Turn rate around x y and z axis
652653
"""

src/wing_geometry.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Represents a wing composed of multiple sections with aerodynamic properties.
3232
- `n_panels::Int64`: Number of panels in aerodynamic mesh
3333
- `spanwise_panel_distribution`::PanelDistribution: [PanelDistribution](@ref)
3434
- `spanwise_direction::Vector{Float64}`: Wing span direction vector
35-
- `sections::Vector{Section}`: List of wing sections
35+
- `sections::Vector{Section}`: List of wing sections, see: [Section](@ref)
3636
3737
"""
3838
mutable struct Wing <: AbstractWing

0 commit comments

Comments
 (0)