[lmi-commits] [lmi] master 07c029f 2/8: Improve documentation

[Greg Chicares]

branch: master
commit 07c029f1da983c54f20e6886579e7357d5473e42
Author: Gregory W. Chicares <address@hidden>
Commit: Gregory W. Chicares <address@hidden>

    Improve documentation
    
    Obviously what is meant is not
      X←(⍴X)↑Y
    but rather
      X[⍳⍴Y]←Y
---
 ledger_invariant.cpp | 2 ++
 ledger_variant.cpp   | 2 +-
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/ledger_invariant.cpp b/ledger_invariant.cpp
index d36c60b..81a1b15 100644
--- a/ledger_invariant.cpp
+++ b/ledger_invariant.cpp
@@ -776,6 +776,8 @@ LedgerInvariant& LedgerInvariant::PlusEq(LedgerInvariant 
const& a_Addend)
     // answer--e.g., for ratios like 'CorridorFactor', where an
     // average weighted by number of lives would be inaccurate,
     // and any aggregate value could be misleading.)
+    //
+    // ET !! This is of the form 'x[iota rho y] gets y'.
     for(int j = 0; j < a_Addend.Length; ++j)
         {
         AnnLoanDueRate[j] = a_Addend.AnnLoanDueRate[j];
diff --git a/ledger_variant.cpp b/ledger_variant.cpp
index 645fd0d..f57649a 100644
--- a/ledger_variant.cpp
+++ b/ledger_variant.cpp
@@ -204,7 +204,7 @@ LedgerVariant& LedgerVariant::PlusEq
     InitTgtPremHiLoadRate       = std::max(InitTgtPremHiLoadRate, 
a_Addend.InitTgtPremHiLoadRate);
     InitMlyPolFee               = std::max(InitMlyPolFee        , 
a_Addend.InitMlyPolFee        );
     InitAnnLoanCredRate         = a_Addend.InitAnnLoanCredRate;
-    // ET !! This is of the form 'x = (lengthof x) take y'.
+    // ET !! This is of the form 'x[iota rho y] gets y'.
     for(int j = 0; j < a_Addend.Length; ++j)
         {
         MlySAIntRate              [j]  = a_Addend.MlySAIntRate              
[j];