slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;roi: document calculation failures

Browse Source
This commit is contained in:
Simon Michael 2020-11-18 10:43:16 -08:00
parent ab305b3244
commit 3afd52248b
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
hledger/Hledger/Cli/Commands/Roi.md
View File

@ -22,6 +22,13 @@ time-weighted rate of return (TWR) for your investments for the time
period requested. Both rates of return are annualized before display, period requested. Both rates of return are annualized before display,
regardless of the length of reporting interval. regardless of the length of reporting interval.
Note, in some cases this report can fail, for these reasons:
- Error (NotBracketed): No solution for Internal Rate of Return (IRR).
Possible causes: IRR is huge (>1000000%), balance of investment becomes negative at some point in time.
- Error (SearchFailed): Failed to find solution for Internal Rate of Return (IRR).
Either search does not converge to a solution, or converges too slowly.
Examples: Examples:
- Using roi to report unrealised gains: - Using roi to report unrealised gains: