Skip to content

Commit

Permalink
docs: update documentation for PortfolioDCF
Browse files Browse the repository at this point in the history
  • Loading branch information
chilango74 committed Oct 9, 2024
1 parent cf33f6f commit 6903549
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions okama/portfolio.py
Original file line number Diff line number Diff line change
Expand Up @@ -2569,6 +2569,13 @@ def survival_period_hist(self, threshold: float = 0) -> float:
The portfolio survival period (longevity period) depends on the investment strategy: asset allocation,
rebalancing, withdrawals rate etc.
Parameters
----------
threshold : float, default 0
The percentage of the initial investments when the portfolio balance considered voided.
This parameter is important to use in cash flow strategies with a fixed
whtdrawal percentage (PercentageStrategy).
Returns
-------
float
Expand Down Expand Up @@ -2604,6 +2611,13 @@ def survival_date_hist(self, threshold: float = 0) -> pd.Timestamp:
The portfolio survival date (longevity date) depends on the investment strategy: asset allocation,
rebalancing, withdrawals rate etc.
Parameters
----------
threshold : float, default 0
The percentage of the initial investments when the portfolio balance considered voided.
This parameter is important to use in cash flow strategies with a fixed
whtdrawal percentage (PercentageStrategy).
Returns
-------
pd.Timestamp
Expand Down Expand Up @@ -3228,7 +3242,7 @@ def _clear_cf_cache(self):

class IndexationStrategy(CashFlow):
"""
Cash flow strategy with indexed withdrawals or contributions.
Cash flow strategy with regualr indexed withdrawals or contributions.
Parameters
----------
Expand Down Expand Up @@ -3321,7 +3335,7 @@ def indexation(self, indexation: Optional[float]):

class PercentageStrategy(CashFlow):
"""
Cash flow strategy with fixed percentage withdrawals or contributions.
Cash flow strategy with regular fixed percentage withdrawals or contributions.
Parameters
----------
Expand Down

0 comments on commit 6903549

Please sign in to comment.