Added comment in the ModeCompleted.msg

[federicociresola]

I added a little comment where a person can see the possible value of nav_state

[hamishwillee]

@bkueng I'm happy with this, but would also have been happy with just the comment on line 15. Does it make sense to you too?

---

As an aside, it would help me to discuss at some point what docs are useful generally for topics and update them all at the same time.
It might even be worth adding some tagging for this - @short, @description, @instances (something to indicate whether there can be multiples). Also to decide whether we allow markdown in the comments and so on.

For example, if we allowed something like:

uint8 nav_state                  # Source mode (`VehicleStatus`)

Then I could know VehicleStatus is a message and auto-cross link or similar.
Just a thought.

[bkueng]

It might even be worth adding some tagging for this - @short, @description, @instances (something to indicate whether there can be multiples). Also to decide whether we allow markdown in the comments and so on.

I'm all for extending the metadata & docs around that. Ideally we do this in ROS and I started a discussion a while ago, but it did not make it any further.