Uploaded image for project: 'Commons CSV'
  1. Commons CSV
  2. CSV-79

CSVFormat.isCommentingDisabled() is confusing/confused

Agile BoardAttach filesAttach ScreenshotVotersWatch issueWatchersCreate sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      The Javadoc for CSVFormat.isCommentingDisabled() says:

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

      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.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              sebb Sebb

              Dates

              • Created:
                Updated:
                Resolved:

                Issue deployment