Skip to content

Commit

Permalink
Merge pull request #760 from cstjean/patch-1
Browse files Browse the repository at this point in the history
Fix step! call in documentation
  • Loading branch information
ChrisRackauckas authored Oct 5, 2024
2 parents 58b4ccf + 1e5f8f0 commit 8d1a060
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/src/basics/integrator.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,12 @@ step!(integrator)
which will take one successful step. Additionally:

```julia
step!(integrator, dt, stop_at_tdt = false)
step!(integrator, dt, false)
```

passing a `dt` will make the integrator continue to step until `integrator.t+dt`, and
setting `stop_at_tdt=true` will add a `tstop` to force it to step to `integrator.t+dt`
passing a `dt` will make the integrator continue to step until at least `integrator.t+dt`, and
passing `true` as the third argument will add a `tstop` to force it to step up to `integrator.t+dt`,
exactly.

To check whether the integration step was successful, you can
call `check_error(integrator)` which returns one of the
Expand Down

0 comments on commit 8d1a060

Please sign in to comment.