[lmi-commits] [lmi] master e33e392 22/33: Correct and reformat the modify_directory() documentation

[Greg Chicares]

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

    Correct and reformat the modify_directory() documentation
    
    A filesystem path is empty if fs::path::empty() returns 'true';
    fs::path::has_filename() means something else.
---
 path_utility.cpp | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/path_utility.cpp b/path_utility.cpp
index 86fa92b..efe61d2 100644
--- a/path_utility.cpp
+++ b/path_utility.cpp
@@ -66,13 +66,14 @@
 /// evokes chdir(2) and cd(1).
 ///
 /// Asserted precondition:
-///   - 'original_filepath' is not empty (i.e., true == has_filename())
+///   - argument 'original_filepath' has a nonempty basename
+///     (i.e., true == has_filename())
 /// It is notably not required that 'supplied_directory' name an
 /// actual existing directory.
 ///
-/// std::filesystem provides no way to test whether a path has the form
-/// of a directory. Its fs::is_directory() asks the operating system
-/// whether or not a directory exists, so
+/// std::filesystem provides no way to test whether a path has the
+/// form of a directory. Its fs::is_directory() asks the operating
+/// system whether or not a directory exists, so
 ///   is_directory("/usr/lib")
 /// returns 'true' iff the OS reports that such a directory exists;
 /// but the same function call would return 'false' after