mesos-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Adam B (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (MESOS-4231) Add a new category to cpplint to detect missing white-space in comments
Date Fri, 15 Jan 2016 07:34:39 GMT

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

Adam B commented on MESOS-4231:
-------------------------------

Untargeting from 0.27 since this issue/fix isn't actually tied to the shipping release, but
to whatever source code is checked out from master. Definitely not a release blocker.

> Add a new category to cpplint to detect missing white-space in comments
> -----------------------------------------------------------------------
>
>                 Key: MESOS-4231
>                 URL: https://issues.apache.org/jira/browse/MESOS-4231
>             Project: Mesos
>          Issue Type: Improvement
>          Components: build
>            Reporter: Avinash Sridharan
>            Assignee: Avinash Sridharan
>            Priority: Minor
>              Labels: mesosphere
>
> Currently we haven't turned on any rule in cpplint.py to detect a missing leading whitespace
in comments. Newbies tend to make this mistake even while trying to follow the style guide.

> There is already a category in cpplint.py (whitespace/comments) to detect this, but it
has the unfortunate side-affect of also tagging any trailing comments with less than 2 whitespaces
between the code and the trailing comment as errors.  This side-affect generates a lot of
false-positives since trailing comments in mesos codebase usually has only a single white-space.
Hence proposing adding a new category called whitespace/mesos-comments that takes care of
the more common case of tagging comments with leading whitespace as errors.   



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

Mime
View raw message