[commons-text] branch master updated: (doc) update definition of upper to match behavior

[ki...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

kinow pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-text.git


The following commit(s) were added to refs/heads/master by this push:
     new 0ddae3b  (doc) update definition of upper to match behavior
0ddae3b is described below

commit 0ddae3b45d9e8db23e5928a1bb7013697b0b5967
Author: Caleb Christiansen <ca...@gmail.com>
AuthorDate: Tue Mar 22 23:24:24 2022 -0700

    (doc) update definition of upper to match behavior
---
 src/main/java/org/apache/commons/text/WordUtils.java | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/commons/text/WordUtils.java b/src/main/java/org/apache/commons/text/WordUtils.java
index e0e70ba..fb848b8 100644
--- a/src/main/java/org/apache/commons/text/WordUtils.java
+++ b/src/main/java/org/apache/commons/text/WordUtils.java
@@ -51,8 +51,7 @@ public class WordUtils {
      *                    If the empty String is passed, the empty string is returned.
      * @param lower       the lower limit; negative value is treated as zero.
      * @param upper       the upper limit; specify -1 if no limit is desired.
-     *                    If the upper limit is lower than the lower limit, it will be
-     *                    adjusted to be the same as the lower limit.
+     *                    The upper limit cannot be lower than the lower limit.
      * @param appendToEnd String to be appended to the end of the abbreviated string.
      *                    This is appended ONLY if the string was indeed abbreviated.
      *                    The append does not count towards the lower or upper limits.