DOC: minor improvement to docs

RocketPy-Team · Sep 17, 2024 · d2926c7 · d2926c7
1 parent 2869e91
commit d2926c7
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/rocketpy/rocket/aero_surface/fins/free_form_fins.py b/rocketpy/rocket/aero_surface/fins/free_form_fins.py
@@ -118,6 +118,8 @@ def __init__(
             List of tuples (x, y) containing the coordinates of the fin's
             geometry defining points. The point (0, 0) is the root leading edge.
             Positive x is rearwards, positive y is upwards (span direction).
+            The shape will be interpolated between the points, in the order
+            they are given. The last point connects to the first point.
         rocket_radius : int, float
             Reference radius to calculate lift coefficient, in meters.
         cant_angle : int, float, optional

diff --git a/rocketpy/rocket/rocket.py b/rocketpy/rocket/rocket.py
@@ -1346,6 +1346,8 @@ def add_free_form_fins(
             List of tuples (x, y) containing the coordinates of the fin's
             geometry defining points. The point (0, 0) is the root leading edge.
             Positive x is rearwards, positive y is upwards (span direction).
+            The shape will be interpolated between the points, in the order
+            they are given. The last point connects to the first point.
         position : int, float
             Fin set position relative to the rocket's coordinate system.
             By fin set position, understand the point belonging to the root