[lmi-commits] [lmi] master 90e8aaf 2/3: Clarify documentation

[Greg Chicares]

branch: master
commit 90e8aaff0931abe896494a47fc077d9eee5f686b
Author: Gregory W. Chicares <gchicares@sbcglobal.net>
Commit: Gregory W. Chicares <gchicares@sbcglobal.net>

    Clarify documentation
    
    Guaranteed-premium solves do "post" values to objects of types
    LedgerInvariant and LedgerVariant, but those objects are discarded:
    they are not "posted" to the object of type Ledger that provides
    the values depicted on an illustration.
---
 ihs_avsolve.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ihs_avsolve.cpp b/ihs_avsolve.cpp
index 67d41a9..f55fcef 100644
--- a/ihs_avsolve.cpp
+++ b/ihs_avsolve.cpp
@@ -322,7 +322,7 @@ void AccountValue::SolveSetWD(currency a_CandidateValue)
 /// so that the guaranteed premium reflects any parameters that have
 /// been adjusted dynamically. It's okay that it overwrites payments
 /// and indeed most other values, because the overwritten values are
-/// not posted to the ledger.
+/// discarded.
 
 currency AccountValue::SolveGuarPremium()
 {