Skip to content
This repository has been archived by the owner on Apr 24, 2023. It is now read-only.

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:

4.4 node_name

does...

4.4.1 Subscribed Topics

4.4.2 Published Topics

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

4.4.3 Services

4.4.4 Services Called

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