Skip to content

Commit 163d959

Browse files
committed
update doc
1 parent b110193 commit 163d959

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

Changelog.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Changelog
22

3-
## 0.8.4 ()
3+
## 0.8.4 (October 2020)
4+
5+
Release 0.8.4 is a minor release and contains bugfixes as well as new features:
46

57
- Bugfix #477: Model callbacks were not added to a LockedHierarchicalMachine when the machine itself served as a model (thanks @oliver-goetz)
68
- Bugfix #475: Clear collection of tasks to prevent memory leak when initializing many models (thanks @h-nakai)

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -1190,6 +1190,7 @@ transitions = [
11901190
]
11911191
# ...
11921192
```
1193+
The `initial` keyword of the `HierarchicalMachine` constructor accepts nested states (e.g. `initial='caffeinated_running'`) and a list of states which is considered to be a parallel state (e.g. `initial=['A', 'B']`) or the current state of another model (`initial=model.state`) which should be effectively one of the previous mentioned options. Note that when passing a string, `transition` will check the targeted state for `initial` substates and use this as an entry state. This will be done recursively until a substate does not mention an initial state. Parallel states or a state passed as a list will be used 'as is' and no further initial evaluation will be conducted.
11931194

11941195
Note that your previously created state object *must be* a `NestedState` or a derived class of it.
11951196
The standard `State` class used in simple `Machine` instances lacks features required for nesting.

0 commit comments

Comments
 (0)