str.1: cleanup
This commit is contained in:
		
							parent
							
								
									15d5761cd7
								
							
						
					
					
						commit
						ee9d42d0d4
					
				
							
								
								
									
										14
									
								
								docs/str.1
									
									
									
									
									
								
							
							
						
						
									
										14
									
								
								docs/str.1
									
									
									
									
									
								
							| @ -6,7 +6,7 @@ | |||||||
| .\" | .\" | ||||||
| .TH STR 1 2024-06-06 "Bonsai Core Utilites 0.13.8" | .TH STR 1 2024-06-06 "Bonsai Core Utilites 0.13.8" | ||||||
| .SH NAME | .SH NAME | ||||||
| str \(en test the character types of string arguments | str \(en test string arguments | ||||||
| .\" | .\" | ||||||
| .SH SYNOPSIS | .SH SYNOPSIS | ||||||
| 
 | 
 | ||||||
| @ -16,7 +16,7 @@ str | |||||||
| .\" | .\" | ||||||
| .SH DESCRIPTION | .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 | The tests in this program are equivalent to the functions with the same names in | ||||||
| .BR ctype.h (0p) | .BR ctype.h (0p) | ||||||
| @ -24,11 +24,8 @@ and are the methods by which string arguments are tested. | |||||||
| .\" | .\" | ||||||
| .SH DIAGNOSTICS | .SH DIAGNOSTICS | ||||||
| 
 | 
 | ||||||
| If all tests pass, the program will exit with an exit code of 0. If any of the | If all tests pass, the program will exit successfully. If any of the tests fail, | ||||||
| tests fail, the program will exit unsuccessfully with an error code of 1. | 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. |  | ||||||
| 
 | 
 | ||||||
| When invoked incorrectly, a debug message will be printed and the program will | When invoked incorrectly, a debug message will be printed and the program will | ||||||
| exit with the appropriate | exit with the appropriate | ||||||
| @ -37,6 +34,9 @@ error code. | |||||||
| .\" | .\" | ||||||
| .SH CAVEATS | .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 | There\(cqs no way of knowing which argument failed the test without re-testing | ||||||
| arguments individually. | arguments individually. | ||||||
| 
 | 
 | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user