[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.
- [lmi-commits] [lmi] master e33e392 22/33: Correct and reformat the modify_directory() documentation, (continued)
- [lmi-commits] [lmi] master e33e392 22/33: Correct and reformat the modify_directory() documentation, Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master fd44389 03/33: Include appropriate headers, and say why they're included, Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master fdc0f5a 07/33: Deboostify even more, Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master 41274a8 14/33: Improve documentation, Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master e4d2f31 08/33: Rename a function, Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master 2038991 15/33: Improve concinnity, Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master 9235f33 16/33: Avoid implicit conversion to fs::path, Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master 4ab2c4e 20/33: Further improve modify_directory() documentation, Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master b64436f 19/33: Improve modify_directory() documentation and tests, Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master 0e3d61a 21/33: Rework modify_directory() documentation; augment unit test, Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master 40096c3 24/33: Conserve 70-character comment width,
Greg Chicares <=
- [lmi-commits] [lmi] master 4473403 29/33: Improve output spacing, Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master bc805ad 28/33: Augment path-validation unit test, Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master 6fd9f69 32/33: Remove the last occurrence of /name.check/, Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master 0c2d6b4 30/33: Revert "Revert "Trap exceptions from filesystem library"", Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master bfa1255 27/33: Enable some tests that were conditionally suppressed, Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master 8538df8 31/33: Improve unit tests and their documentation, Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master 6ddb0fa 25/33: Rework a 'wine' workaround again, Greg Chicares, 2021/05/03
- [lmi-commits] [lmi] master 0296ac4 33/33: Deboostify still more, Greg Chicares, 2021/05/03