This repository has been archived by the owner on Apr 24, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 120
Formatting Guidelines
Alejandro Escontrela edited this page Oct 27, 2018
·
4 revisions
For consistency and ease of use, Documentation added to this repository should adhere to the ROS StyleGuide. For example, proper formatting for nodes is as follows:
does...
- foo/topic_name1 (std_msgs/String)
- topic_desciption 1
- foo/topic_name (std_msgs/String)
- topic description, including any important rate information
- foo/service_name (nav_msgs/GetMap)
- service description
- foo/service_name (nav_msgs/GetMap)
- service description
- ~parameter_name (type, default: value)
- parameter description
- ~parameter_name (type, default: value)
- parameter description
- foo → bar
- description of transform
- baz → mumble
- description of transform