commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LANG-1182) javadoc correction, clarification on 2 variants of StringUtils.containsAny()
Date Sun, 08 Nov 2015 21:54:10 GMT

    [ https://issues.apache.org/jira/browse/LANG-1182?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14995826#comment-14995826
] 

ASF GitHub Bot commented on LANG-1182:
--------------------------------------

GitHub user PascalSchumacher opened a pull request:

    https://github.com/apache/commons-lang/pull/114

    LANG-1182: adding clarifying examples to StringUtils#containsAny javadoc

    as suggested by Larry West in https://issues.apache.org/jira/browse/LANG-1182

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/PascalSchumacher/commons-lang LANG-1182

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/commons-lang/pull/114.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #114
    
----
commit 1260e09d6f2314c7099d061f1c65e6b4275cb8a1
Author: Pascal Schumacher <pascalschumacher@gmx.net>
Date:   2015-11-08T21:44:07Z

    LANG-1182: adding clarifying examples to StringUtils#containsAny javadoc
    
    as suggested by Larry West in https://issues.apache.org/jira/browse/LANG-1182

----


> javadoc correction, clarification on 2 variants of StringUtils.containsAny()
> ----------------------------------------------------------------------------
>
>                 Key: LANG-1182
>                 URL: https://issues.apache.org/jira/browse/LANG-1182
>             Project: Commons Lang
>          Issue Type: Bug
>          Components: lang.*
>    Affects Versions: 3.4
>            Reporter: Larry West
>            Priority: Minor
>   Original Estimate: 1h
>  Remaining Estimate: 1h
>
> (1) The javadoc for StringUtils.containsAny(CharSequence cs, CharSequence... searchCharSequences)
confusingly says 
>      * StringUtils.containsAny("abcd", "ab", "cd") = false
> You can verify this actually returns true by running this:
>         if (!StringUtils.containsAny("abcd", "ab", "cd")) 
>             throw new AssertionError("Third sample from StringUtils 3.4 javadoc");
> (2) The javadoc for containsAny(final CharSequence cs, final CharSequence searchChars)
is inadequate, and could easily mislead naive readers to believe this containsAny() looks
for a matching sequence (substring) rather than characters in a set:
>      * StringUtils.containsAny("zzabyycdxx", "za") = true
>      * StringUtils.containsAny("zzabyycdxx", "by") = true
> In other words, both examples would be equally true for StringUtils.contains().  I suggest
adding clarifying examples, like:
>       * StringUtils.containsAny("zzabyycdxx", "\tx") = true
>       * StringUtils.containsAny("zzabyycdxx", "$.#yF") = true



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message