Formatting Guidelines

---

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:

4.4 node_name

does...

4.4.1 Subscribed Topics

• foo/topic_name1 (std_msgs/String)
  • topic_desciption 1

4.4.2 Published Topics

• foo/topic_name (std_msgs/String)
  • topic description, including any important rate information

4.4.3 Services

• foo/service_name (nav_msgs/GetMap)
  • service description

4.4.4 Services Called

• foo/service_name (nav_msgs/GetMap)
  • service description

4.4.5 Parameters

• ~parameter_name (type, default: value)
  • parameter description

4.4.6 Parameters Set

• ~parameter_name (type, default: value)
  • parameter description

4.4.7 Required tf Transforms

• foo → bar
  • description of transform

4.4.8 Provided tf Transforms

• baz → mumble
  • description of transform