Skip to content

Commit 90acba7

Browse files
committed
MNT: Docstring updates to various files related to 3 dof
1 parent f3f3b0a commit 90acba7

File tree

3 files changed

+4
-12
lines changed

3 files changed

+4
-12
lines changed

docs/user/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ RocketPy's User Guide
77

88
Installation and Requirements <installation.rst>
99
First Simulation <first_simulation.rst>
10-
3 DOF Simulations and comparison <three_dof_simulation.rst>
10+
3 DOF Simulations and Comparison <three_dof_simulation.rst>
1111

1212
.. toctree::
1313
:maxdepth: 1

docs/user/three_dof_simulation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@ in the :class:`rocketpy.Flight` class:
418418
inclination=85,
419419
heading=45,
420420
simulation_mode="3 DOF",
421-
weathercock_coeff=1.0, # Default value
421+
weathercock_coeff=1.0, # Example with weathercocking enabled
422422
)
423423

424424
print(f"Apogee: {flight.apogee - env.elevation:.2f} m")

tests/integration/simulation/test_flight_3dof.py

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,8 @@ def test_simulation_mode_sets_3dof_with_point_mass_rocket(flight_3dof):
108108
109109
Parameters
110110
----------
111-
example_plain_env : rocketpy.Environment
112-
A basic environment fixture for flight simulation.
113-
point_mass_rocket : rocketpy.PointMassRocket
114-
A point mass rocket fixture for 3-DOF simulation.
111+
flight_3dof : rocketpy.simulation.flight.Flight
112+
A Flight fixture configured for 3-DOF simulation with a PointMassRocket.
115113
"""
116114
assert flight_3dof.simulation_mode == "3 DOF"
117115

@@ -145,12 +143,6 @@ def test_u_dot_generalized_3dof_returns_valid_result(flight_3dof):
145143
Verifies that the u_dot_generalized_3dof method returns a list or numpy
146144
array representing the state derivative vector.
147145
148-
Parameters
149-
----------
150-
example_plain_env : rocketpy.Environment
151-
A basic environment fixture for flight simulation.
152-
point_mass_rocket : rocketpy.PointMassRocket
153-
A point mass rocket fixture for 3-DOF simulation.
154146
"""
155147
flight = flight_3dof
156148
u = [0] * 13 # Generalized state vector size

0 commit comments

Comments
 (0)