[Python] Fix documentation for Sim1D.set_steady_callback

This commit is contained in:
Ray Speth 2016-11-10 14:04:20 -05:00
parent d34b94230f
commit 2d623e893e

View file

@ -571,9 +571,9 @@ cdef class Sim1D:
def set_steady_callback(self, f):
"""
Set a callback function to be called after each successful timestep.
The signature of *f* is `float f(float)`. The argument passed to *f* is
"0" and the output is ignored.
Set a callback function to be called after each successful steady-state
solve, before regridding. The signature of *f* is `float f(float)`. The
argument passed to *f* is "0" and the output is ignored.
"""
if not isinstance(f, Func1):
f = Func1(f)