diff --git a/docs/str.1 b/docs/str.1 index c3f7538..d45289a 100644 --- a/docs/str.1 +++ b/docs/str.1 @@ -6,7 +6,7 @@ .\" .TH STR 1 2024-06-06 "Bonsai Core Utilites 0.13.8" .SH NAME -str \(en test the character types of string arguments +str \(en test string arguments .\" .SH SYNOPSIS @@ -16,7 +16,7 @@ str .\" .SH DESCRIPTION -Test string arguments. +Test the character types of string arguments. The tests in this program are equivalent to the functions with the same names in .BR ctype.h (0p) @@ -24,11 +24,8 @@ and are the methods by which string arguments are tested. .\" .SH DIAGNOSTICS -If all tests pass, the program will exit with an exit code of 0. If any of the -tests fail, the program will exit unsuccessfully with an error code of 1. - -An empty string will cause an unsuccessful exit as none of its contents pass any -tests. +If all tests pass, the program will exit successfully. If any of the tests fail, +the program will exit unsuccessfully with an error code of 1. When invoked incorrectly, a debug message will be printed and the program will exit with the appropriate @@ -37,6 +34,9 @@ error code. .\" .SH CAVEATS +None of an empty string\(cqs contents pass any of the tests, so the program will +exit unsuccessfully if one is specified. + There\(cqs no way of knowing which argument failed the test without re-testing arguments individually.