diff --git a/CHANGELOG.md b/CHANGELOG.md index 0d168763a..2e8635f16 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -36,6 +36,7 @@ Attention: The newest changes should be on top --> ### Changed +- DOCS: reshape docs (closes #659) [#781](https://github.com/RocketPy-Team/RocketPy/pull/781) - MNT: EmptyMotor class inherits from Motor(ABC) [#779](https://github.com/RocketPy-Team/RocketPy/pull/779) ### Fixed diff --git a/docs/user/motors/thrust.rst b/docs/user/motors/thrust.rst index cbe327032..4359023b6 100644 --- a/docs/user/motors/thrust.rst +++ b/docs/user/motors/thrust.rst @@ -164,6 +164,8 @@ class also supports them. Let's see how to use it. ) solid_lambda.info() +.. _reshaping_thrust_curve: + Reshaping and interpolating the thrust curve -------------------------------------------- diff --git a/rocketpy/motors/motor.py b/rocketpy/motors/motor.py index cad0a60f4..5f4b0dc0b 100644 --- a/rocketpy/motors/motor.py +++ b/rocketpy/motors/motor.py @@ -878,7 +878,8 @@ def propellant_I_23(self): def reshape_thrust_curve(thrust, new_burn_time, total_impulse): """Transforms the thrust curve supplied by changing its total burn time and/or its total impulse, without altering the - general shape of the curve. + general shape of the curve. This method does not mutate the original + object, it only returns a new thrust curve. Parameters ---------- @@ -893,6 +894,10 @@ def reshape_thrust_curve(thrust, new_burn_time, total_impulse): ------- Function Reshaped thrust curve. + + Tip + --- + See the User Guide page for examples on how to use this method. """ # Retrieve current thrust curve data points time_array, thrust_array = thrust.x_array, thrust.y_array