Skip to content

Commit

Permalink
Documentation about run_in_background
Browse files Browse the repository at this point in the history
Documentation about run_in_background still introduces *callback* parameter as a callable which accepts both an interpreter and a list of macrosteps.
  • Loading branch information
AlexandreDecan committed Jan 28, 2016
1 parent f5a90a9 commit 7e31457
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/advancedtopics/dealingtime.rst
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,5 @@ function that run an interpreter in a thread, and does the job of synchronizing
Final: []

.. note:: An optional argument ``callback`` can be passed to :py:func:`~sismic.interpreter.run_in_background`.
It must be a callable that accepts an :py:class:`~sismic.interpreter.Interpreter` instance and a (possibly empty) list
of :py:class:`~sismic.model.MacroStep`. This callable will be called each time the interpreter's ``execute`` method
is called.
It must be a callable that accepts the (possibly empty) list of :py:class:`~sismic.model.MacroStep` returned by
the underlying call to :py:meth:`~sismic.interpreter.Interpreter.execute`.

0 comments on commit 7e31457

Please sign in to comment.