Add an example with an initial state in the documentation

AlexandreDecan · Jan 21, 2016 · d576849 · d576849
1 parent eb29ed1
commit d576849
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/docs/format.rst b/docs/format.rst
@@ -137,6 +137,20 @@ Such a state is commonly called a *composite state*.
         states:
           - name: nested state 2a
 
+A composite state can define its initial state using *initial*.
+
+.. code:: yaml
+
+  - name: composite state
+    initial: nested state 1
+    states:
+      - name: nested state 1
+      - name: nested state 2
+        initial: nested state a2
+        states:
+          - name: nested state 2a
+
+
 Regions
 *******