add docstring

SciML · Feb 15, 2018 · 7092d2c · 7092d2c
1 parent 3178bd9
commit 7092d2c
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/integrator_interface.jl b/src/integrator_interface.jl
@@ -182,6 +182,13 @@ intervals(integrator::DEIntegrator) = IntegratorIntervals(integrator)
 end
 
 
+"""
+    step!(integ::DEIntegrator [, dt])
+Perform one (successful) step on the integrator.
+
+Alternative, if a `dt` is given, then `step!` the integrator until
+there is a temporal difference `≥ dt` in `integ.t`.
+"""
 function step!(integ::DEIntegrator, dt::Real)
     t = integ.t
     while integ.t < t + dt