There are many cases where the same node or topic has different names in different places.
Examples:
(simulated_motor_endpoint.py / class SimulatedMotor / motor_simulator ) all directly reference the "motor_simulator" node but are inconsistent.
(LocalPlanner.motion_pub / topic "nav_cmd" / SimulatedMotor.planned_motion_subscriber) all directly reference the "nav_cmd" topic but are inconsistent.
@spragunr Perhaps not a top priority, but I think this could cause a lot of confusion, especially for someone that doesn't realize how inconsistent names are.
Proposed solution:
Class field names for a topic subscription should be named [topic_name]_sub
Class field names for a topic publisher should be named [topic_name]_pub
Callback functions for a topic subscription should be named [topic_name]_callback
Python files for a node, classes for a node, and the actual node name should all be the same, but in different cases. With class name in Capitalized Camel Case, file name and node name in snake case.
TODO: Create documentation for this.
Note: there may be other things (not topic/node) that are named inconsistently.
Note: could a linter rule be setup to enforce consistent naming?
There are many cases where the same node or topic has different names in different places.
Examples:
@spragunr Perhaps not a top priority, but I think this could cause a lot of confusion, especially for someone that doesn't realize how inconsistent names are.
Proposed solution:
[topic_name]_sub
[topic_name]_pub
[topic_name]_callback
TODO: Create documentation for this.
Note: there may be other things (not topic/node) that are named inconsistently. Note: could a linter rule be setup to enforce consistent naming?