[lmi-commits] [lmi] master 92911ca 07/10: Improve documentation

[Greg Chicares]

branch: master
commit 92911cac6dd9af5775b58ce387961a9b8456a741
Author: Gregory W. Chicares <address@hidden>
Commit: Gregory W. Chicares <address@hidden>

    Improve documentation
---
 rate_table.cpp | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/rate_table.cpp b/rate_table.cpp
index 4b63a42..090e739 100644
--- a/rate_table.cpp
+++ b/rate_table.cpp
@@ -270,6 +270,10 @@ struct soa_field
     char const* name;               // Field name in the text format.
 };
 
+// The following two enums are deliberately distinct despite their
+// close similarity, for reasons explained at length here:
+//   https://lists.nongnu.org/archive/html/lmi/2018-02/msg00030.html
+
 // This enum defines the indices of all the known fields in soa_fields array,
 // its elements are consecutive.
 enum enum_soa_field