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

[Greg Chicares]

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

    Clarify documentation
    
    A reviewer reading this:
    
    /// Any extension or path is discarded from the input census filepath;
    
    naturally expects stem() to be called. Explained why it isn't.
---
 path_utility.cpp | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/path_utility.cpp b/path_utility.cpp
index 554ab69..c379ef2 100644
--- a/path_utility.cpp
+++ b/path_utility.cpp
@@ -216,7 +216,9 @@ std::string serial_extension
 /// Precondition: census input filepath has a nonempty basename.
 ///
 /// Any extension or path is discarded from the input census filepath;
-/// only the basename is used.
+/// only the basename is used. In std::filesystem terms, that would
+/// seem to suggest calling stem(), but stem() is not called; instead,
+/// filename() is extracted, and then replace_extension() is called.
 ///
 /// Apply portable_filename() to the census filename and the insured's
 /// name: because they're under end-user control, they may contain