Apply suggestions from code review

docs: add nuance to the docstring Co-authored-by: Vishwa Shah <vishwa2710@gmail.com>
open-space-collective · Nov 21, 2023 · f6ac7b3 · f6ac7b3
1 parent 4c761da
commit f6ac7b3
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Model.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Model.cpp
@@ -67,7 +67,7 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_Profile_Model(pybind11::modul
             "calculate_states_at",
             &Model::calculateStatesAt,
             R"doc(
-                Calculate the states of the model at specific instants. This method is preferred over calling `calculate_state_at` multiple times since there is a performance gain.
+                Calculate the states of the model at specific instants. It can be more performant than looping `calculate_state_at` for multiple instants.
 
                 Args:
                     instants (list[Instant]): The instants at which to calculate the states.

diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory.cpp
@@ -97,7 +97,7 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory(pybind11::module& aModule
             "get_states_at",
             &Trajectory::getStatesAt,
             R"doc(
-                Get the states of the trajectory at a given set of instants. This method is preferred over calling `get_state_at` multiple times since there is a performance gain.
+                Get the states of the trajectory at a given set of instants. It can be more performant than looping `calculate_state_at` for multiple instants.
 
                 Args:
                     instants (list[Instant]): The instants.

diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Model.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Model.cpp
@@ -68,7 +68,7 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Model(pybind11::module &a
             &BaseModel::calculateStatesAt,
             arg("instants"),
             R"doc(
-                Calculate the states at given instants. This method is preferred over calling `calculate_state_at` multiple times since there is a performance gain.
+                Calculate the states at given instants. It can be more performant than looping `calculate_state_at` for multiple instants.
 
                 @param instants The instants.
 

diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Propagator.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Propagator.cpp
@@ -172,7 +172,7 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Propagator(pybind11::modu
             arg("state"),
             arg("instant_array"),
             R"doc(
-                Calculate the states at given instants. This method is preferred over calling `calculate_state_at` multiple times since there is a performance gain.
+                Calculate the states at given instants. It is more performant than looping `calculate_state_at` for multiple instants.
 
                 Args:
                     state (State) The state.