lmi-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[lmi-commits] [lmi] master 40096c3 24/33: Conserve 70-character comment


From: Greg Chicares
Subject: [lmi-commits] [lmi] master 40096c3 24/33: Conserve 70-character comment width
Date: Mon, 3 May 2021 08:15:54 -0400 (EDT)

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

    Conserve 70-character comment width
    
    In block comments already formatted to a seventy-character maximum
    width, strive not to widen any line beyond that maximum.
---
 path_utility.cpp | 8 ++++----
 view_ex.cpp      | 2 +-
 2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/path_utility.cpp b/path_utility.cpp
index efe61d2..9232cbb 100644
--- a/path_utility.cpp
+++ b/path_utility.cpp
@@ -204,7 +204,7 @@ std::string serial_extension
 /// Motivation: see
 ///   https://savannah.nongnu.org/support/?105907
 /// The output filename is composed of:
-///  - the census input filename, which identifies the case;
+///  - the census input basename, which identifies the case;
 ///  - the insured's name, if nonempty, except in regression tests;
 ///  - the serial number of the insured within the census; and
 ///  - an extension appropriate to the output type.
@@ -213,11 +213,11 @@ std::string serial_extension
 /// output filenames simpler and more regular, yet doesn't suppress
 /// any information that would actually be useful.
 ///
-/// Preconditions: census input filepath is nonempty and has a filename.
-/// For example `path/without/name/` is nonempty but hasn't the filename.
+/// Preconditions: census input filepath is nonempty and has a
+/// nonempty basename.
 ///
 /// Any extension or path is discarded from the input census filepath;
-/// only the filename is used.
+/// only the basename is used.
 ///
 /// Apply portable_filename() to the census filename and the insured's
 /// name: because they're under end-user control, they may contain
diff --git a/view_ex.cpp b/view_ex.cpp
index e22c72b..0715d54 100644
--- a/view_ex.cpp
+++ b/view_ex.cpp
@@ -199,7 +199,7 @@ void ViewEx::OnDraw(wxDC*)
 ///
 /// Using wxDocument::GetUserReadableName() means the name can be
 /// altered by calling wxDocument::SetTitle(). By default, the title
-/// is the filename with no path. The call to filename() guarantees that
+/// is the filename with no path. Calling filename() guarantees that
 /// the result is pathless, even if e.g. the title has been set to the
 /// document's full filepath. If filename() is empty, then a name that
 /// recognizably should never be uttered is returned.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]