commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sebb (Created) (JIRA)" <j...@apache.org>
Subject [jira] [Created] (CSV-79) CSVFormat.isCommentingDisabled() is very confused
Date Wed, 21 Mar 2012 17:05:40 GMT
CSVFormat.isCommentingDisabled() is very confused
-------------------------------------------------

                 Key: CSV-79
                 URL: https://issues.apache.org/jira/browse/CSV-79
             Project: Commons CSV
          Issue Type: Bug
            Reporter: Sebb


The Javadoc for CSVFormat.isCommentingDisabled() says:

{code}
/**
 * Specifies whether comments are supported by this format.
 * 
 * @return <tt>true</tt> is comments are supported, <tt>false</tt>
otherwise
 */
{code}

however the method actually does the opposite, as the name suggests.

Now we could just fix the Javadoc, but given that the other isXXX methods return a positive
result this would be inconsistent.

Also, it's generally better to return positive setting.

So I think renaming the method as "isCommentingEnabled" - and fixing the method code - would
be better.


--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message