Skip to content
This repository has been archived by the owner on Jun 10, 2021. It is now read-only.

Follow ROS2 Style Guide #50

Closed
dabonnie opened this issue Dec 20, 2019 · 6 comments
Closed

Follow ROS2 Style Guide #50

dabonnie opened this issue Dec 20, 2019 · 6 comments
Labels
bug Something isn't working

Comments

@dabonnie
Copy link
Contributor

Description

Many constants defined in this project do not follow the guidelines for ROS2 Development. These should be respected.

Expected Behavior

Constants following style guide naming convention.

Actual Behavior

Constant naming does not follow the style guide naming convention.

@dabonnie dabonnie added the bug Something isn't working label Dec 20, 2019
@dabonnie
Copy link
Contributor Author

Opened #51

@mm318
Copy link
Member

mm318 commented Dec 21, 2019

There's more to this than just the names of the constants.

@thomas-moulard
Copy link
Member

thomas-moulard commented Dec 23, 2019

@mm318 Could you list what you think is missing from this ticket? This will make your comment actionable.

@mm318
Copy link
Member

mm318 commented Dec 23, 2019

The other issues that are immediately noticeable are:

  • Function names need to UpperCamelCase
  • Class member variables need to be suffixed with _

These are being addressed in #53.

@mm318
Copy link
Member

mm318 commented Dec 26, 2019

Also found that some class and function comments start with a noun (a subject) or with a singular verb (imperative mood) and do not end with proper punctuation (a period).

Looking at the examples, it seems like both class and function comments should be in the indicative mood without a subject (the subject is implied to be the class or function that the comment is for) with proper punctuation.

@dabonnie
Copy link
Contributor Author

Closed via #51 and #56

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants