Fix docstrings

Author: ufechner7

ext/VortexStepMethodControlPlotsExt.jl

@@ -278,8 +278,8 @@ Plot wing geometry from different viewpoints and optionally save/show plots.
 - `save_path`: path for saving the graphic (default: `nothing`)
 - `is_save`: boolean value, indicates if the graphic shall be saved (default: `false`)
 - `is_show`: boolean value, indicates if the graphic shall be displayed (default: `false`)
-- `view_elevation`: initial view elevation angle (default: 15) [°]
-- `view_azimuth`: initial view azimuth angle (default: -120) [°]
+- `view_elevation`: initial view elevation angle in degrees (default: 15)
+- `view_azimuth`: initial view azimuth angle in degrees (default: -120)
 - `use_tex`: if the external `pdflatex` command shall be used (default: false)
 
 """
@@ -505,9 +505,9 @@ Generate polar data for aerodynamic analysis over a range of angles.
 
 # Keyword arguments
 - `angle_type`: Type of angle variation ("angle_of_attack" or "side_slip")
-- `angle_of_attack`: Initial angle of attack [rad]
-- `side_slip`: Initial side slip angle in [rad]
-- `v_a`: norm of apparent wind speed [m/s]
+- `angle_of_attack`: Initial angle of attack in radians
+- `side_slip`: Initial side slip angle in radians
+- `v_a`: Norm of apparent wind speed in m/s
 
 # Returns
 - Tuple of polar data array and Reynolds number
@@ -530,11 +530,11 @@ Plot polar data comparing different solvers and configurations.
 
 # Keyword arguments
 - `literature_path_list`: Optional paths to literature data files
-- `angle_range`: Range of angles to analyze [°]
+- `angle_range`: Range of angles to analyze in degrees
 - `angle_type`: "`angle_of_attack`" or "`side_slip`"; (default: `angle_of_attack`)
-- `angle_of_attack:` AoA to be used for plotting the polars (default: 0.0) [rad]
-- `side_slip`: side slip angle (default: 0.0) [rad]
-- v_a: norm of apparent wind speed (default: 10.0) [m/s]
+- `angle_of_attack:` AoA to be used for plotting the polars in radians (default: 0.0)
+- `side_slip`: side slip angle in radians (default: 0.0)
+- `v_a`: norm of apparent wind speed in m/s (default: 10.0)
 - title: plot title
 - `data_type`: File extension for saving (default: ".pdf")
 - `save_path`: Path to save plots (default: nothing)
@@ -749,8 +749,8 @@ relative to the 2d airfoil or panel chord line.
 - `body_aero`: Wing aerodynamics struct
 
 # Keyword arguments
-- `alphas`: Range of angle of attack values in radians (default: -5° to 25° in 0.3° steps)
-- `delta_tes`: Range of trailing edge angles in radians (default: -5° to 25° in 0.3° steps)
+- `alphas`: Range of angle of attack values in radians (default: `deg2rad.(-5:0.3:25)`)
+- `delta_tes`: Range of trailing edge angles in radians (default: `deg2rad.(-5:0.3:25)`)
 - `is_show`: Whether to display plots (default: true)
 - `use_tex`: if the external `pdflatex` command shall be used
 """

ext/VortexStepMethodMakieExt.jl

@@ -449,8 +449,8 @@ Plot wing geometry from different viewpoints using Makie.
 - `save_path`: Path for saving (default: nothing)
 - `is_save`: Whether to save (default: false)
 - `is_show`: Whether to display (default: false)
-- `view_elevation`: View elevation angle [°] (default: 15)
-- `view_azimuth`: View azimuth angle [°] (default: -120)
+- `view_elevation`: View elevation angle in degrees (default: 15)
+- `view_azimuth`: View azimuth angle in degrees (default: -120)
 - `use_tex`: Ignored for Makie (default: false)
 """
 function VortexStepMethod.plot_geometry(body_aero::BodyAerodynamics, title;
@@ -633,9 +633,9 @@ Generate polar data for aerodynamic analysis over a range of angles.
 
 # Keyword arguments
 - `angle_type`: Type of angle variation ("angle_of_attack" or "side_slip")
-- `angle_of_attack`: Initial angle of attack [rad]
-- `side_slip`: Initial side slip angle [rad]
-- `v_a`: norm of apparent wind speed [m/s]
+- `angle_of_attack`: Initial angle of attack in radians
+- `side_slip`: Initial side slip angle in radians
+- `v_a`: Norm of apparent wind speed in m/s
 
 # Returns
 - Tuple of polar data array and Reynolds number
@@ -658,11 +658,11 @@ Plot polar data comparing different solvers using Makie.
 
 # Keyword arguments
 - `literature_path_list`: Optional paths to literature data files
-- `angle_range`: Range of angles [°]
+- `angle_range`: Range of angles in degrees
 - `angle_type`: "angle_of_attack" or "side_slip" (default: angle_of_attack)
-- `angle_of_attack`: AoA [rad] (default: 0.0)
-- `side_slip`: Side slip angle [rad] (default: 0.0)
-- `v_a`: Wind speed [m/s] (default: 10.0)
+- `angle_of_attack`: AoA in radians (default: 0.0)
+- `side_slip`: Side slip angle in radians (default: 0.0)
+- `v_a`: Wind speed in m/s (default: 10.0)
 - `title`: Plot title
 - `data_type`: File extension (default: ".png", also supports ".jpeg")
 - `save_path`: Path to save (default: nothing)
@@ -851,8 +851,8 @@ Plot polar data (Cl, Cd, Cm) as 3D surfaces using Makie.
 - `body_aero`: Wing aerodynamics struct
 
 # Keyword arguments
-- `alphas`: Range of AoA values [rad] (default: -5° to 25° in 0.3° steps)
-- `delta_tes`: Range of trailing edge angles [rad] (default: -5° to 25° in 0.3° steps)
+- `alphas`: Range of AoA values in radians (default: `deg2rad.(-5:0.3:25)`)
+- `delta_tes`: Range of trailing edge angles in radians (default: `deg2rad.(-5:0.3:25)`)
 - `is_show`: Whether to display (default: true)
 - `use_tex`: Ignored for Makie (default: false)
 """
@@ -932,8 +932,8 @@ Create combined multi-panel figure with geometry, polar data, distributions, and
 - `side_slip`: Side slip in degrees (default: 0.0)
 - `v_a`: Wind speed in m/s (default: 10.0)
 - `title`: Overall figure title (default: "Combined Analysis")
-- `view_elevation`: Geometry view elevation [°] (default: 15)
-- `view_azimuth`: Geometry view azimuth [°] (default: -120)
+- `view_elevation`: Geometry view elevation in degrees (default: 15)
+- `view_azimuth`: Geometry view azimuth in degrees (default: -120)
 - `is_show`: Display figure (default: true)
 - `use_tex`: Ignored for Makie (default: false)
 - `literature_path_list`: Paths to literature CSV files (default: String[])

src/settings.jl

@@ -60,7 +60,7 @@ Solver configuration, used within [`VSMSettings`](@ref).
 - `aerodynamic_model_type`: [`VSM`](@ref Model) or
     [`LLT`](@ref Model) (default `VSM`)
 - `solver_type`: `"LOOP"` or `"NONLIN"` (default `"LOOP"`)
-- `density`: Air density [kg/m³] (default `1.225`)
+- `density`: Air density (kg/m^3) (default `1.225`)
 - `max_iterations`: Maximum solver iterations (default `1500`)
 - `rtol`: Relative tolerance (default `1e-5`)
 - `tol_reference_error`: Reference error tolerance
@@ -77,7 +77,7 @@ Solver configuration, used within [`VSMSettings`](@ref).
     available (default `true`)
 - `core_radius_fraction`: Vortex core radius fraction
     (default `1e-20`)
-- `mu`: Dynamic viscosity [N·s/m²] (default `1.81e-5`)
+- `mu`: Dynamic viscosity (N*s/m^2) (default `1.81e-5`)
 - `calc_only_f_and_gamma`: Only output forces and circulation
     (default `false`)
 - `correct_aoa`: Perform angle of attack correction
@@ -111,7 +111,7 @@ Can be constructed from keyword arguments or loaded from a YAML
 file with `VSMSettings(filename)`.
 
 # Fields
-- `condition`: [`ConditionSettings`] (wind speed, alpha, beta,
+- `condition`: `ConditionSettings` (wind speed, alpha, beta,
     yaw rate)
 - `wings`: Vector of [`WingSettings`](@ref)
 - `solver_settings`: [`SolverSettings`](@ref)

src/solver.jl

@@ -978,8 +978,8 @@ refinement), with each control angle affecting one unrefined section.
 # Keyword Arguments
 - `theta_idxs`: Indices in `y` for twist angles (one per unrefined section, default: 1:4)
 - `delta_idxs`: Indices in `y` for trailing edge deflections (one per unrefined section, default: nothing)
-- `va_idxs`: Indices in `y` for apparent wind velocity [vx, vy, vz] (default: nothing)
-- `omega_idxs`: Indices in `y` for angular velocity [ωx, ωy, ωz] (default: nothing)
+- `va_idxs`: Indices in `y` for apparent wind velocity components `(vx, vy, vz)` (default: nothing)
+- `omega_idxs`: Indices in `y` for angular velocity components `(ωx, ωy, ωz)` (default: nothing)
 - `aero_coeffs::Bool`: Return force/moment coefficients instead of dimensional values (default: false)
 - `kwargs...`: Additional arguments passed to `solve!`
 
@@ -994,8 +994,8 @@ Jacobian computation. When the same angles are encountered, geometry deformation
 # Returns
 - `jac::Matrix{Float64}`: Jacobian matrix (m×n) where m = 6 + n_unrefined_sections, n = length(y)
 - `results::Vector{Float64}`: Output vector at operating point
-  - If `aero_coeffs=false`: [Fx, Fy, Fz, Mx, My, Mz, moment_unrefined_dist...]
-  - If `aero_coeffs=true`: [CFx, CFy, CFz, CMx, CMy, CMz, cm_unrefined_dist...]
+    - If `aero_coeffs=false`: `(Fx, Fy, Fz, Mx, My, Mz, moment_unrefined_dist...)`
+    - If `aero_coeffs=true`: `(CFx, CFy, CFz, CMx, CMy, CMz, cm_unrefined_dist...)`
 
 # Example
 ```julia