docs: fix documentation for State.in_frame (#452)

open-space-collective · Oct 24, 2024 · 88e4315 · 88e4315
1 parent 5554801
commit 88e4315
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State.cpp
@@ -266,13 +266,13 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State(pybind11::module& a
             "in_frame",
             &State::inFrame,
             R"doc(
-                Check if the state is in a given reference frame.
+                Transform the state to the provided reference frame.
 
                 Args:
-                    frame (Frame): The reference frame to check.
+                    frame (Frame): The reference frame to transform to.
 
                 Returns:
-                    bool: True if the state is in the reference frame, False otherwise.
+                    State: The transformed state.
             )doc",
             arg("frame")
         )