Skip to content

Commit 02d219d

Browse files
committed
improve doc string
1 parent a068e76 commit 02d219d

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

src/plotting.jl

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,9 @@ function plot_distribution(y_coordinates_list, results_list, label_list;
463463
end
464464

465465
"""
466-
generate_polar_data(solver, wing_aero::WingAerodynamics, angle_range; kwargs...)
466+
generate_polar_data(solver, wing_aero::WingAerodynamics, angle_range;
467+
angle_type="angle_of_attack", angle_of_attack=0.0,
468+
side_slip=0.0, v_a=10.0)
467469
468470
Generate polar data for aerodynamic analysis over a range of angles.
469471
@@ -474,9 +476,9 @@ Generate polar data for aerodynamic analysis over a range of angles.
474476
475477
# Keyword arguments
476478
- `angle_type`: Type of angle variation ("angle_of_attack" or "side_slip")
477-
- `angle_of_attack`: Initial angle of attack in radians
478-
- `side_slip`: Initial side slip angle in radians
479-
- `v_a`: Magnitude of velocity
479+
- `angle_of_attack`: Initial angle of attack [rad]
480+
- `side_slip`: Initial side slip angle in [rad]
481+
- `v_a`: norm of apparent wind speed [m/s]
480482
481483
# Returns
482484
- Tuple of polar data array and Reynolds number

0 commit comments

Comments
 (0)