From 9fb713d804c30fe9c7f404d41911f6c95a3649d0 Mon Sep 17 00:00:00 2001
From: Michael Jumper <mjumper@apache.org>
Date: Wed, 23 Jan 2019 18:51:53 -0800
Subject: [PATCH] GUACAMOLE-637: Correct grammar of documentation for
 guac_strl*() unit tests.

---
 src/libguac/tests/string/strlcat.c  | 18 +++++++++---------
 src/libguac/tests/string/strlcpy.c  |  6 ++++--
 src/libguac/tests/string/strljoin.c | 14 +++++++-------
 3 files changed, 20 insertions(+), 18 deletions(-)

diff --git a/src/libguac/tests/string/strlcat.c b/src/libguac/tests/string/strlcat.c
index 739f1ee1..fb0c62aa 100644
--- a/src/libguac/tests/string/strlcat.c
+++ b/src/libguac/tests/string/strlcat.c
@@ -24,10 +24,10 @@
 #include <string.h>
 
 /**
- * Verify guac_strlcat() behavior when string fits buffer without truncation.
- * The return value of each call should be the length of the resulting string.
- * Each resulting string should contain the full result of the contatenation,
- * including null terminator.
+ * Verify guac_strlcat() behavior when the string fits the buffer without
+ * truncation. The return value of each call should be the length of the
+ * resulting string. Each resulting string should contain the full result of
+ * the contatenation, including null terminator.
  */
 void test_string__strlcat() {
 
@@ -66,11 +66,11 @@ void test_string__strlcat() {
 }
 
 /**
- * Verify guac_strlcat() behavior when string must be truncated to fit buffer.
- * The return value of each call should be the length that would result from
- * concatenating the strings given an infinite buffer, however only as many
- * characters as can fit should be appended to the string within the buffer,
- * and the buffer should be null-terminated.
+ * Verify guac_strlcat() behavior when the string must be truncated to fit the
+ * buffer. The return value of each call should be the length that would result
+ * from concatenating the strings given an infinite buffer, however only as
+ * many characters as can fit should be appended to the string within the
+ * buffer, and the buffer should be null-terminated.
  */
 void test_string__strlcat_truncate() {
 
diff --git a/src/libguac/tests/string/strlcpy.c b/src/libguac/tests/string/strlcpy.c
index d543ee63..1e8e01e3 100644
--- a/src/libguac/tests/string/strlcpy.c
+++ b/src/libguac/tests/string/strlcpy.c
@@ -24,7 +24,8 @@
 #include <string.h>
 
 /**
- * Verify guac_strlcpy() behavior when string fits buffer without truncation.
+ * Verify guac_strlcpy() behavior when the string fits the buffer without
+ * truncation.
  */
 void test_string__strlcpy() {
 
@@ -53,7 +54,8 @@ void test_string__strlcpy() {
 }
 
 /**
- * Verify guac_strlcpy() behavior when string must be truncated to fit buffer.
+ * Verify guac_strlcpy() behavior when the string must be truncated to fit the
+ * buffer.
  */
 void test_string__strlcpy_truncate() {
 
diff --git a/src/libguac/tests/string/strljoin.c b/src/libguac/tests/string/strljoin.c
index eb7f44e7..39932885 100644
--- a/src/libguac/tests/string/strljoin.c
+++ b/src/libguac/tests/string/strljoin.c
@@ -45,10 +45,10 @@ const char* const empty_a_empty_b[] = { "", "A", "", "B" };
 const char* const empty_x10[] = { "", "", "", "", "", "", "", "", "", "" };
 
 /**
- * Verify guac_strljoin() behavior when string fits buffer without truncation.
- * The return value of each call should be the length of the resulting string.
- * Each resulting string should contain the full result of the join operation,
- * including null terminator.
+ * Verify guac_strljoin() behavior when the string fits the buffer without
+ * truncation. The return value of each call should be the length of the
+ * resulting string. Each resulting string should contain the full result of
+ * the join operation, including null terminator.
  */
 void test_string__strljoin() {
 
@@ -82,9 +82,9 @@ void test_string__strljoin() {
 }
 
 /**
- * Verify guac_strljoin() behavior when string must be truncated to fit buffer.
- * The return value of each call should be the length that would result from
- * joining the strings given an infinite buffer, however only as many
+ * Verify guac_strljoin() behavior when the string must be truncated to fit the
+ * buffer. The return value of each call should be the length that would result
+ * from joining the strings given an infinite buffer, however only as many
  * characters as can fit should be appended to the string within the buffer,
  * and the buffer should be null-terminated.
  */