Annotating events for MPF docsΒΆ

You usually write the following to post an event in code:

# this event is posted when something awesome happens"your_awesome_event", reason=what_happened)

This will work. However, nobody will know about your shiny new event. Therefore, we want to document it for our users. Since it would be dublicate work to document the event in code and in the docs, we use a custom docblock annotation:"your_awesome_event", reason=what_happened)
'''event: your_awesome_event

desc: This event is posted when something awesome happens. We suggest that
you play a loud sound and show some flashy slides when this happens.

  reason: The reason for this awesomeness is stated here.

The event will be automatically added to the event reference on the next update of the documentation.