Skip to content

Commit

Permalink
ENH: added documentation regarding CTRL+C - issue scrtlabs#288
Browse files Browse the repository at this point in the history
  • Loading branch information
EmbarAlmog committed Jun 12, 2018
1 parent df87ccc commit a49fcf1
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/source/live-trading.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ algorithm for live trading. The same algorithm should work in
backtest and live execution mode without modification.
What differs are the arguments provided to the catalyst client or
`run_algorithm()` interface. Here is the same example in both interfaces:
``run_algorithm()`` interface. Here is the same example in both interfaces:
.. code-block:: bash
Expand Down Expand Up @@ -227,3 +227,9 @@ from the exchanges.
Currently, in paper trading and backtest modes the commissions are reduced
**always** from the quote currency defined on the algorithm (we will align
these modes in the future with live mode).
.. note::
In live mode, as in backtest, at the end of the algorithm run (by reaching a predefined end date
or by receiving a CTRL+C interrupt) the ``analyze`` function is being called.

0 comments on commit a49fcf1

Please sign in to comment.