From f234624050f4b86aad2b7ab64af2b9b5765a5f1a Mon Sep 17 00:00:00 2001 From: Gui-FernandesBR Date: Sat, 10 Feb 2024 12:05:32 -0500 Subject: [PATCH] MNT: Fix typos --- rocketpy/plots/monte_carlo_plots.py | 7 ++++--- rocketpy/simulation/monte_carlo.py | 2 +- rocketpy/stochastic/stochastic_aero_surfaces.py | 8 ++++---- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/rocketpy/plots/monte_carlo_plots.py b/rocketpy/plots/monte_carlo_plots.py index d729b5ccd..5ff028387 100644 --- a/rocketpy/plots/monte_carlo_plots.py +++ b/rocketpy/plots/monte_carlo_plots.py @@ -28,7 +28,7 @@ def ellipses( The path to the image to be used as the background actual_landing_point : tuple, optional A tuple containing the actual landing point of the rocket, if known. - Useful when comparing the monte_carlo results with the actual landing. + Useful when comparing the Monte Carlo results with the actual landing. Must be given in tuple format, such as (x, y) in meters. By default None. perimeterSize : int, optional @@ -109,7 +109,8 @@ def ellipses( # Add title and labels to plot ax.set_title( - "1$\\sigma$, 2$\\sigma$ and 3$\\sigma$ monte_carlo Ellipses: Apogee and Landing Points" + "1$\\sigma$, 2$\\sigma$ and 3$\\sigma$ " + + "Monte Carlo Ellipses: Apogee and Landing Points" ) ax.set_ylabel("North (m)") ax.set_xlabel("East (m)") @@ -146,7 +147,7 @@ def ellipses( plt.show() def all_results(self, keys=None): - """Plot the results of the monte_carlo analysis. + """Plot the results of the Monte Carlo analysis. Parameters ---------- diff --git a/rocketpy/simulation/monte_carlo.py b/rocketpy/simulation/monte_carlo.py index 10a526016..b21bbfa8a 100644 --- a/rocketpy/simulation/monte_carlo.py +++ b/rocketpy/simulation/monte_carlo.py @@ -61,7 +61,7 @@ class MonteCarlo: prints : _MonteCarloPrints Object with methods to print information about the monte carlo simulation. - plot : _MonteCarloPlots + plots : _MonteCarloPlots Object with methods to plot information about the monte carlo simulation. """ diff --git a/rocketpy/stochastic/stochastic_aero_surfaces.py b/rocketpy/stochastic/stochastic_aero_surfaces.py index 1fc633380..8b406fe6a 100644 --- a/rocketpy/stochastic/stochastic_aero_surfaces.py +++ b/rocketpy/stochastic/stochastic_aero_surfaces.py @@ -227,7 +227,7 @@ def create_object(self): Returns ------- - trapezoidalfins : TrapezoidalFins + fins : TrapezoidalFins TrapezoidalFins object with the randomly generated input arguments. """ generated_dict = next(self.dict_generator()) @@ -334,7 +334,7 @@ def create_object(self): Returns ------- - ellipticalfins : EllipticalFins + fins : EllipticalFins EllipticalFins object with the randomly generated input arguments. """ generated_dict = next(self.dict_generator()) @@ -388,7 +388,7 @@ def __init__( See Also -------- - This should link to somewhere that explains how inputs works in + TODO: This should link to somewhere that explains how inputs works in stochastic models. Parameters @@ -497,7 +497,7 @@ def create_object(self): Returns ------- - railbuttons : RailButtons + rail_buttons : RailButtons RailButtons object with the randomly generated input arguments. """ generated_dict = next(self.dict_generator())