From 3afd52248b1be13448566effdb78bd85418b5530 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Wed, 18 Nov 2020 10:43:16 -0800 Subject: [PATCH] ;roi: document calculation failures --- hledger/Hledger/Cli/Commands/Roi.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/hledger/Hledger/Cli/Commands/Roi.md b/hledger/Hledger/Cli/Commands/Roi.md index cd9cc093c..2a12858cd 100644 --- a/hledger/Hledger/Cli/Commands/Roi.md +++ b/hledger/Hledger/Cli/Commands/Roi.md @@ -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, 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: - Using roi to report unrealised gains: