Skip to content

Commit 2b35d8c

Browse files
committed
update doc
1 parent 2540f49 commit 2b35d8c

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/source/analytics.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -801,12 +801,24 @@ Deal Assumption
801801
Stop Run
802802
^^^^^^^^^^^^^^
803803

804+
A debugging assumption to stop the deal projection. Either stop by a specific date or by a :ref:`Condition`.
805+
804806
cashflow projection will stop at the date specified.
805807

806808
.. code-block:: python
807809
808810
("stop","2021-01-01")
809811
812+
.. versionadded:: 0.46.5
813+
814+
After 0.46.5, the stop run can be specified by a :ref:`Condition` which will be evaluated on each distribution date described by :ref:`DatePattern`.
815+
816+
("stop", <DatePattern>, *<Condition>)
817+
818+
.. code-block:: python
819+
820+
# on each month end, the engine will evaluate two conditions, stop projection when ALL of them are met
821+
("stop", "MonthEnd", [">=","2022-01-01"], [("bondBalance","A1"),"<=",200])
810822
811823
812824
Project Expense

0 commit comments

Comments
 (0)