Skip to content

Commit 88e4315

Browse files
authored
docs: fix documentation for State.in_frame (#452)
1 parent 5554801 commit 88e4315

File tree

1 file changed

+3
-3
lines changed
  • bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory

1 file changed

+3
-3
lines changed

bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -266,13 +266,13 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State(pybind11::module& a
266266
"in_frame",
267267
&State::inFrame,
268268
R"doc(
269-
Check if the state is in a given reference frame.
269+
Transform the state to the provided reference frame.
270270
271271
Args:
272-
frame (Frame): The reference frame to check.
272+
frame (Frame): The reference frame to transform to.
273273
274274
Returns:
275-
bool: True if the state is in the reference frame, False otherwise.
275+
State: The transformed state.
276276
)doc",
277277
arg("frame")
278278
)

0 commit comments

Comments
 (0)