From 389f5ea2dfb17780431f32afa32f8004fb1a856a Mon Sep 17 00:00:00 2001 From: ArneBouillon <45404227+ArneBouillon@users.noreply.github.com> Date: Sun, 17 Dec 2023 15:07:05 +0100 Subject: [PATCH] Update documentation of `save_start` and `save_end` --- docs/src/interfaces/Common_Keywords.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/src/interfaces/Common_Keywords.md b/docs/src/interfaces/Common_Keywords.md index 28b80882f..5d7977751 100644 --- a/docs/src/interfaces/Common_Keywords.md +++ b/docs/src/interfaces/Common_Keywords.md @@ -58,10 +58,14 @@ section at the end of this page for some example usage. settings of `dense`, `saveat` and `save_everystep` and is used by some applications to manually turn off saving temporarily. Everyday use of the solvers should leave this unchanged. Defaults to `true`. -* `save_start`: Denotes whether the initial condition should be included in - the solution type as the first timepoint. Defaults to `true`. -* `save_end`: Denotes whether the final timepoint is forced to be saved, - regardless of the other saving settings. Defaults to `true`. +* `save_start`: Denotes whether the initial condition should be included in the solution + type as the first timepoint. This setting overrides `saveat` when set to `false`. + Defaults to + `save_everystep || isempty(saveat) || saveat isa Number || prob.tspan[1] in saveat`. +* `save_end`: Denotes whether the final condition should be included in the solution type + as the final timepoint. This setting is overridden by other saving settings when set to + `false`. Defaults to + `save_everystep || isempty(saveat) || saveat isa Number || prob.tspan[2] in saveat`. * `initialize_save`: Denotes whether to save after the callback initialization phase (when `u_modified=true`). Defaults to `true`.