Skip to content

Commit

Permalink
Prepare for 0.17.0
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexandreDecan committed Jan 19, 2016
1 parent d192fef commit 300ceb5
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 5 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Changelog
=========

Unreleased
----------
0.17.0 (unreleased)
-------------------

Many backward incompatible changes in this update, especially if you used to work with ``model``.
The YAML format of a statechart also changed, look carefully at the changelog and the documentation.
Expand Down
3 changes: 1 addition & 2 deletions docs/format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,7 @@ Notice the use of the ``description`` field in the YAML specification given belo
Importing and validating statecharts
------------------------------------

The :py:class:`~sismic.model.Statechart` class provides several methods to construct, to query and to manipulate a statechart.
A YAML definition of a statechart can be easily imported to a :py:class:`~sismic.model.Statechart` instance.
The module :py:mod:`sismic.io` provides a convenient loader :py:func:`~sismic.io.import_from_yaml`
which takes a textual YAML definition of a statechart.
Expand All @@ -242,10 +243,8 @@ For example:
statechart = io.import_from_yaml(f)
assert isinstance(statechart, model.Statechart)


The parser performs an automatic validation against the YAML schema of the next subsection.


YAML validation schema
**********************

Expand Down
2 changes: 1 addition & 1 deletion sismic/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
__description__ = 'Sismic Interactive State Machine Interpreter and Checker'
__version__ = '0.16.0'
__version__ = '0.17.0'
__url__ = 'https://github.com/AlexandreDecan/sismic/'
__author__ = 'Alexandre Decan'
__email__ = 'alexandre.decan@lexpage.net'
Expand Down

0 comments on commit 300ceb5

Please sign in to comment.