docs: clarify altitude definition in Orbit constructors (#475)

doc: clarify altitude definition in Orbit ctors
open-space-collective · Dec 18, 2024 · 8481615 · 8481615
1 parent 6956a4e
commit 8481615
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit.cpp
@@ -282,7 +282,7 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit(pybind11::module& a
 
                     Args:
                         epoch (Instant): The epoch.
-                        altitude (Length): The altitude.
+                        altitude (Length): The altitude (wrt. equatorial radius).
                         inclination (Angle): The inclination.
                         celestial_object (Celestial): The celestial object.
 
@@ -303,8 +303,8 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit(pybind11::module& a
 
                     Args:
                         epoch (Instant): The epoch.
-                        apoapsis_altitude (Length): The apoapsis altitude.
-                        periapsis_altitude (Length): The periapsis altitude.
+                        apoapsis_altitude (Length): The apoapsis altitude (wrt. equatorial radius).
+                        periapsis_altitude (Length): The periapsis altitude (wrt. equatorial radius).
                         celestial_object (Celestial): The celestial object.
 
                     Returns:
@@ -323,7 +323,7 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit(pybind11::module& a
 
                     Args:
                         epoch (Instant): The epoch.
-                        altitude (Length): The altitude.
+                        altitude (Length): The altitude (wrt. equatorial radius).
                         celestial_object (Celestial): The celestial object.
 
                     Returns:
@@ -365,7 +365,7 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit(pybind11::module& a
 
                     Args:
                         epoch (Instant): The epoch.
-                        altitude (Length): The altitude.
+                        altitude (Length): The altitude (wrt. equatorial radius).
                         local_time_at_descending_node (Time): The local time at descending node.
                         celestial_object (Celestial): The celestial object.
                         argument_of_latitude (Angle): The argument of latitude.
@@ -410,7 +410,7 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit(pybind11::module& a
 
                     Args:
                         epoch (Instant): The epoch.
-                        altitude (Length): The altitude.
+                        altitude (Length): The altitude (wrt. equatorial radius).
                         celestial_object (Celestial): The celestial object.
                         eccentricity (float): The eccentricity.
                         inclination (Angle): The inclination.