Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cpplint: Disable whitespace/todo #13763

Merged
merged 1 commit into from
Jul 31, 2020

Conversation

jwnimmer-tri
Copy link
Collaborator

@jwnimmer-tri jwnimmer-tri commented Jul 29, 2020

In preparation for enabling C-style comment linting, we disable the whitespace rules for TODOs. They go beyond what GSG demands, and it is unclear how to apply them to C-style comments.

Related to #13762 and RobotLocomotion/styleguide#31.


This change is Reviewable

In preparation for enabling C-style comment linting, we disable the
whitespace rules for TODOs.  They go beyond what GSG demands, and
it is unclear how to apply them to C-style comments.
@SeanCurtis-TRI SeanCurtis-TRI self-assigned this Jul 29, 2020
Copy link
Contributor

@SeanCurtis-TRI SeanCurtis-TRI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:LGTM: Since I happened by.
+@SeanCurtis-TRI

Reviewed 1 of 1 files at r1.
Reviewable status: needs at least two assigned reviewers

@jwnimmer-tri jwnimmer-tri marked this pull request as ready for review July 29, 2020 17:03
@rpoyner-tri rpoyner-tri self-assigned this Jul 29, 2020
Copy link
Contributor

@rpoyner-tri rpoyner-tri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm: +@rpoyner-tri

Reviewable status: labeled "do not merge" (waiting on @rpoyner-tri)

Copy link
Contributor

@ggould-tri ggould-tri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

Reviewed 1 of 1 files at r1.
Reviewable status: labeled "do not merge" (waiting on @rpoyner-tri)

Copy link
Member

@soonho-tri soonho-tri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

Reviewed 1 of 1 files at r1.
Reviewable status: labeled "do not merge" (waiting on @rpoyner-tri)

Copy link
Member

@sherm1 sherm1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did this just enforce that there is a single space between the TODO() and the text in TODO(someone) text or is it more subtle? If it's just that why is it a problem in a C-style comment?

Reviewable status: labeled "do not merge" (waiting on @rpoyner-tri)

Copy link
Member

@sherm1 sherm1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per f2f: thanks! :lgtm:

Reviewable status: labeled "do not merge" (waiting on @rpoyner-tri)

@jwnimmer-tri
Copy link
Collaborator Author

jwnimmer-tri commented Jul 29, 2020

Did this just enforce that there is a single space between the TODO() and the text in TODO(someone) text ...

For the record -- yes, it did that but it also enforced exactly once space at the start // TODO(...) between comment opener and the TODO. That was awkward to try to teach how to deal with C style comments in that way I'm implementing it. In Drake we allow for differing amounts of leading whitespace in the middle of C-style comment blocks.

@jwnimmer-tri
Copy link
Collaborator Author

Hearing no objections, I'll merge this now.

@jwnimmer-tri jwnimmer-tri merged commit dc2a939 into RobotLocomotion:master Jul 31, 2020
@jwnimmer-tri jwnimmer-tri deleted the whitespace-todo branch July 31, 2020 13:04
thduynguyen pushed a commit to thduynguyen/drake that referenced this pull request Aug 7, 2020
In preparation for enabling C-style comment linting, we disable the
whitespace rules for TODOs.  They go beyond what GSG demands, and
it is unclear how to apply them to C-style comments.
thduynguyen pushed a commit to thduynguyen/drake that referenced this pull request Aug 22, 2020
In preparation for enabling C-style comment linting, we disable the
whitespace rules for TODOs.  They go beyond what GSG demands, and
it is unclear how to apply them to C-style comments.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants