Documentation

docs/execution.rst

@@ -378,8 +378,8 @@ As our statechart does not define any way to reach a final configuration, the ``
 always hold, and you have to manually interrupt the execution.
 
 
-Interactive but continuous execution
-************************************
+Using *threading*
+*****************
 
 Notice from previous example that using such a loop, you are not able to send event to the interpreter.
 Consider the following example involving the :py:mod:`threading` module as a tiny workaround:
@@ -417,7 +417,7 @@ Consider the following example involving the :py:mod:`threading` module as a tin
 
 
 For convenience, module :py:mod:`~sismic.interpreter` provides a :py:func:`~sismic.interpreter.run_in_background`
-function:
+function that does the job for you.
 
 .. autofunction:: sismic.interpreter.run_in_background
 

docs/format.rst

@@ -219,11 +219,22 @@ or define a guard.
 Example
 *******
 
-Full example of a statechart definition using YAML.
+Elevator
+^^^^^^^^
+
+The Elevator statechart will be one of the running example in this documentation.
 
 .. literalinclude:: ../examples/concrete/elevator.yaml
    :language: yaml
 
+Microwave
+^^^^^^^^^
+
+Notice the use of ``description``. This field will be ignored when imported into
+Sismic, but can be used to provide additional information about the statechart.
+
+.. literalinclude:: ../examples/concrete/microwave.yaml
+    :language: yaml
 
 Defining statecharts in Python
 ------------------------------

sismic/__init__.py

@@ -2,7 +2,7 @@
 from . import evaluator, io, model, interpreter, stories
 
 __description__ = 'Sismic Interactive State Machine Interpreter and Checker'
-__version__ = '0.11.1'
+__version__ = '0.11.2'
 __url__ = 'https://github.com/AlexandreDecan/sismic/'
 __author__ = 'Alexandre Decan'
 __email__ = 'alexandre.decan@lexpage.net'