Skip to content

Commit ee00684

Browse files
committed
docs: improve numerical solver python docs
1 parent 2851844 commit ee00684

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

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

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,10 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_NumericalSolver(pyb
290290
R"doc(
291291
Return a Numerical Solver using a fixed stepper.
292292
293+
Args:
294+
stepper_type (NumericalSolver.StepperType): The type of stepper.
295+
time_step (float): The time step.
296+
293297
Returns:
294298
NumericalSolver: The numerical solver.
295299
)doc",
@@ -308,17 +312,27 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_NumericalSolver(pyb
308312
Returns:
309313
NumericalSolver: The default conditional numerical solver.
310314
)doc",
311-
arg("state_logger") = nullptr
315+
arg_v("state_logger", nullptr, "None")
312316
)
313317
.def_static(
314318
"conditional",
315319
&NumericalSolver::Conditional,
316320
R"doc(
317321
Return a conditional numerical solver.
318322
323+
Args:
324+
time_step (float): The time step.
325+
relative_tolerance (float): The relative tolerance.
326+
absolute_tolerance (float): The absolute tolerance.
327+
state_logger (StateLogger, optional): The state logger. Defaults to None.
328+
319329
Returns:
320330
NumericalSolver: The conditional numerical solver.
321-
)doc"
331+
)doc",
332+
arg("time_step"),
333+
arg("relative_tolerance"),
334+
arg("absolute_tolerance"),
335+
arg_v("state_logger", nullptr, "None")
322336
);
323337
}
324338
}

0 commit comments

Comments
 (0)