Skip to content

Commit f3ad1dc

Browse files
committed
DOC: update docstrings for new tests parameters.
1 parent abd5ca5 commit f3ad1dc

1 file changed

Lines changed: 23 additions & 8 deletions

File tree

tests/test_flight.py

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -791,8 +791,12 @@ def test_accelerations(flight_calisto_custom_wind, flight_time, expected_values)
791791
----------
792792
flight_calisto_custom_wind : rocketpy.Flight
793793
Flight object to be tested. See the conftest.py file for more info.
794-
atol : float, optional
795-
The absolute tolerance error, by default 5e-3
794+
flight_time : str
795+
The name of the attribute of the flight object that contains the time
796+
of the point to be tested.
797+
expected_values : tuple
798+
The expected values of the acceleration vector at the point to be
799+
tested.
796800
"""
797801
expected_attr, expected_acc = flight_time, expected_values
798802

@@ -826,8 +830,11 @@ def test_velocities(flight_calisto_custom_wind, flight_time, expected_values):
826830
----------
827831
flight_calisto_custom_wind : rocketpy.Flight
828832
Flight object to be tested. See the conftest.py file for more info.
829-
atol : float, optional
830-
The absolute tolerance error, by default 5e-3
833+
flight_time : str
834+
The name of the attribute of the flight object that contains the time
835+
of the point to be tested.
836+
expected_values : tuple
837+
The expected values of the velocity vector at the point to be tested.
831838
"""
832839
expected_attr, expected_vel = flight_time, expected_values
833840

@@ -861,8 +868,12 @@ def test_aerodynamic_forces(flight_calisto_custom_wind, flight_time, expected_va
861868
----------
862869
flight_calisto_custom_wind : rocketpy.Flight
863870
Flight object to be tested. See the conftest.py file for more info.
864-
atol : float, optional
865-
The absolute tolerance error, by default 5e-3
871+
flight_time : str
872+
The name of the attribute of the flight object that contains the time
873+
of the point to be tested.
874+
expected_values : tuple
875+
The expected values of the aerodynamic forces vector at the point to be
876+
tested.
866877
"""
867878
expected_attr, expected_R = flight_time, expected_values
868879

@@ -896,8 +907,12 @@ def test_aerodynamic_moments(flight_calisto_custom_wind, flight_time, expected_v
896907
----------
897908
flight_calisto_custom_wind : rocketpy.Flight
898909
Flight object to be tested. See the conftest.py file for more info.
899-
atol : float, optional
900-
The absolute tolerance error, by default 5e-3
910+
flight_time : str
911+
The name of the attribute of the flight object that contains the time
912+
of the point to be tested.
913+
expected_values : tuple
914+
The expected values of the aerodynamic moments vector at the point to
915+
be tested.
901916
"""
902917
expected_attr, expected_M = flight_time, expected_values
903918

0 commit comments

Comments
 (0)