From 9c07adc394a8fc6622ed476feffc291abc27b22b Mon Sep 17 00:00:00 2001 From: Alexander Neumann Date: Wed, 24 Oct 2018 23:42:15 +0200 Subject: [PATCH] Add remarks to state extenions; increase changelog; this fixes #318 --- Changelog.md | 5 +++++ README.md | 2 ++ 2 files changed, 7 insertions(+) diff --git a/Changelog.md b/Changelog.md index e5cea342..90051ba2 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1,5 +1,10 @@ # Changelog +## 0.6.9 () + +- Bugfix #314: Do not override already defined model functions with convenience functions (thanks @Arkanayan) +- Bugfix #316: `state.Error` did not call parent's `enter` method (thanks @potens1) + ## 0.6.8 (May, 2018) Release 0.6.8 is a minor release and contains a critical bugfix: diff --git a/README.md b/README.md index 0785f484..45627bc1 100644 --- a/README.md +++ b/README.md @@ -1255,6 +1255,7 @@ Currently, transitions comes equipped with the following state features: - keyword: `timeout` (int, optional) -- if passed, an entered state will timeout after `timeout` seconds - keyword: `on_timeout` (string/callable, optional) -- will be called when timeout time has been reached - will raise an `AttributeError` when `timeout` is set but `on_timeout` is not + - Note: A timeout is triggered in a thread. This implies several limitations (e.g. catching Exceptions raised in timeouts). Consider an event queue for more sophisticated applications. * **Tags** -- adds tags to states - keyword: `tags` (list, optional) -- assigns tags to a state @@ -1264,6 +1265,7 @@ Currently, transitions comes equipped with the following state features: - inherits from `Tags` (if you use `Error` do not use `Tags`) - keyword: `accepted` (bool, optional) -- marks a state as accepted - alternatively the keyword `tags` can be passed, containing 'accepted' + - Note: Errors will only be raised if `auto_transitions` has been set to `False`. Otherwise every state can be exited with `to_` methods. * **Volatile** -- initialises an object every time a state is entered - keyword: `volatile` (class, optional) -- every time the state is entered an object of type class will be assigned to the model. The attribute name is defined by `hook`. If omitted, an empty VolatileObject will be created instead