[jira] [Comment Edited] (REEF-1112) Update TodoComment checkstyle check

["Mariia Mykhailova (JIRA)" <ji...@apache.org>]

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

Mariia Mykhailova edited comment on REEF-1112 at 12/22/15 6:56 PM:
-------------------------------------------------------------------

I suggest we add new clauses of TodoComment check instead of updating existing ones. Existing ones are already either info or error in many modules, and adding new clause is easier.

Also, we need to be careful enforcing FIX and XXX. Our code often uses PREFIX (which is valid word) and xxx as part of string constant, so the format needs to be more elaborate to avoid false positives.


was (Author: mariiamykhailova):
I suggest we add new clauses of TodoComment check instead of updating existing ones. Existing ones are already either info or error in many modules, and adding new clause is easier.

> Update TodoComment checkstyle check
> -----------------------------------
>
>                 Key: REEF-1112
>                 URL: https://issues.apache.org/jira/browse/REEF-1112
>             Project: REEF
>          Issue Type: Sub-task
>          Components: Build infrastructure, Documentation
>            Reporter: Sergey Dudoladov
>
> Currently, the check catches only TODO tags. We should add other common tags such as FIXME, FIX and XXX. Suggested configuration add-on:
> {code:xml}
> <module name="TodoComment">
>     <property name="format" value="(TODO)|(FIXME)|(FIX)|(XXX)"/>
>     <property name="severity" value="warning"/>
> </module>
> {code}



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