Merge pull request #605 from RocketPy-Team/enh/environment-class-majo…

…r-refactor-may-2024 ENH: Environment class major refactor may 2024
RocketPy-Team · Jul 12, 2024 · 45971e9 · 45971e9
2 parents 92f8c97 + 3f83395
commit 45971e9
Show file tree

Hide file tree

Showing 14 changed files with 2,359 additions and 2,140 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -36,6 +36,7 @@ Attention: The newest changes should be on top -->
 
 ### Changed
 
+- ENH: Environment class major refactor may 2024 [#605](https://github.com/RocketPy-Team/RocketPy/pull/605)
 - MNT: Refactors the code to adopt pylint [#621](https://github.com/RocketPy-Team/RocketPy/pull/621)
 - MNT: Refactor AeroSurfaces [#634](https://github.com/RocketPy-Team/RocketPy/pull/634)
 

diff --git a/rocketpy/environment/__init__.py b/rocketpy/environment/__init__.py
@@ -1,2 +1,9 @@
+"""The rocketpy.environment module is responsible for the Atmospheric and Earth
+models. The methods and classes not listed in the __all__ variable will be
+considered private and should be used with caution.
+"""
+
 from .environment import Environment
 from .environment_analysis import EnvironmentAnalysis
+
+__all__ = ["Environment", "EnvironmentAnalysis"]