[prev in list] [next in list] [prev in thread] [next in thread] 

List:       jakarta-commons-dev
Subject:    [jira] [Updated] (LANG-1070) confusing example in ArrayUtils.add()
From:       "Paul Pogonyshev (JIRA)" <jira () apache ! org>
Date:       2014-11-29 18:18:12
Message-ID: JIRA.12758459.1417284959000.42018.1417285092310 () Atlassian ! JIRA
[Download RAW message or body]


     [ https://issues.apache.org/jira/browse/LANG-1070?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel \
]

Paul Pogonyshev updated LANG-1070:
----------------------------------
    Description: 
Method documentation claims that

    ArrayUtils.add(null, null)     = null

However, this is not true since this parameter combination leads to an exception.

Either remove this line from documentation, or rewrite it to explicitly mention the \
exception. Maybe there are other related methods with similar problem in the docs.

  was:
Method documentation claims that

    ArrayUtils.addAll(null, null)     = null

However, this is not true since this parameter combination leads to an exception.

Either remove this line from documentation, or rewrite it to explicitly mention the \
exception.


> confusing example in ArrayUtils.add()
> -------------------------------------
> 
> Key: LANG-1070
> URL: https://issues.apache.org/jira/browse/LANG-1070
> Project: Commons Lang
> Issue Type: Improvement
> Components: lang.*
> Affects Versions: 3.3.2
> Reporter: Paul Pogonyshev
> Priority: Trivial
> 
> Method documentation claims that
> ArrayUtils.add(null, null)     = null
> However, this is not true since this parameter combination leads to an exception.
> Either remove this line from documentation, or rewrite it to explicitly mention the \
> exception. Maybe there are other related methods with similar problem in the docs.



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


[prev in list] [next in list] [prev in thread] [next in thread]