Skip to content

Commit e09ec4e

Browse files
committed
improve docstrings
1 parent 9909bfd commit e09ec4e

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

src/panel.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Represents a panel in a vortex step method simulation. All points and vectors ar
2626
- `y_airf::MVec3`: Unit vector parallel to chord line
2727
- `z_airf::MVec3`: Unit vector in spanwise direction
2828
- `width::Float64`: Panel width
29-
- `filaments::Vector{BoundFilament}`: Panel filaments
29+
- `filaments::Vector{BoundFilament}`: Panel filaments, see: [BoundFilament](@ref)
3030
"""
3131
mutable struct Panel
3232
TE_point_1::MVec3

src/solver.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ Main solver structure for the Vortex Step Method.
77
# Attributes
88
99
## General settings
10-
- `aerodynamic_model_type`::Symbol
11-
- density::Float64
10+
- `aerodynamic_model_type`::Model: The model type, see: [Model](@ref)
11+
- density::Float64: Air density [kg/m³]
1212
- `max_iterations`::Int64
13-
- `allowed_error`::Float64
13+
- `allowed_error`::Float64: relative error
1414
- `tol_reference_error`::Float64
1515
- `relaxation_factor`::Float64
1616

0 commit comments

Comments
 (0)