[lmi-commits] [lmi] master 1f8415a5 2/2: Improve documentation

[Greg Chicares]

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

    Improve documentation
    
    One might at first parse "one-twelfth divided by one minus itself"
    as meaning ((1/12) / 1) - ((1/12) / 1), and then need to backtrack
    because that cannot be the meaning. Inserted a clarifying comma to
    guide the reader to the intended meaning, (1/12) / (1 - (1/12).
---
 commutation_functions_test.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/commutation_functions_test.cpp b/commutation_functions_test.cpp
index 7ce12e9a..71d0464a 100644
--- a/commutation_functions_test.cpp
+++ b/commutation_functions_test.cpp
@@ -595,7 +595,7 @@ void OLCommFnsTest()
 /// value would therefore differ. That's one important reason why UL
 /// commutation functions cannot replace a general monthiversary loop.
 ///
-/// The monthly COI rate is limited to one-eleventh: one-twelfth
+/// The monthly COI rate is limited to one-eleventh: one-twelfth,
 /// divided by one minus itself, because deducting the COI charge at
 /// the beginning of the month increases the amount actually at risk:
 ///   https://lists.nongnu.org/archive/html/lmi/2009-09/msg00001.html