[GitHub] [commons-lang] garydgregory commented on a change in pull request #779: LANG-1664: Fix javadoc (separator is a character, not a string)

[GitBox <gi...@apache.org>]

garydgregory commented on a change in pull request #779:
URL: https://github.com/apache/commons-lang/pull/779#discussion_r674766444



##########
File path: src/main/java/org/apache/commons/lang3/StringUtils.java
##########
@@ -8721,7 +8721,7 @@ public static String substringAfterLast(final String str, final String separator
      * </pre>
      *
      * @param str the String to get a substring from, may be null
-     * @param separator the String to search for, may be null
+     * @param separator the character (Unicode code point) to search for

Review comment:
       Why did you remove the documentation for null input?

##########
File path: src/main/java/org/apache/commons/lang3/StringUtils.java
##########
@@ -8639,7 +8639,7 @@ public static String substringAfter(final String str, final String separator) {
      * </pre>
      *
      * @param str  the String to get a substring from, may be null
-     * @param separator  the String to search for, may be null
+     * @param separator the character (Unicode code point) to search for

Review comment:
       Why did you remove the documentation for null input?

##########
File path: src/main/java/org/apache/commons/lang3/StringUtils.java
##########
@@ -8560,7 +8560,7 @@ public static String substring(final String str, int start, int end) {
      * </pre>
      *
      * @param str  the String to get a substring from, may be null
-     * @param separator  the character to search.
+     * @param separator the character (Unicode code point) to search for

Review comment:
       Sentences should end in a period. Sentences feel quite awkward (to me) ending in a preposition.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@commons.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org