aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRaimo Niskanen <[email protected]>2016-09-20 17:03:24 +0200
committerRaimo Niskanen <[email protected]>2016-09-20 17:03:24 +0200
commit1778a9e0c677134a6b71975168812bcfdc70c7aa (patch)
tree4974a4a6526d6fd6c3637dabee34c6aa3e40b58b
parent4ebdabdca2c964887115f21405993f3916843d10 (diff)
downloadotp-1778a9e0c677134a6b71975168812bcfdc70c7aa.tar.gz
otp-1778a9e0c677134a6b71975168812bcfdc70c7aa.tar.bz2
otp-1778a9e0c677134a6b71975168812bcfdc70c7aa.zip
Improve docs
-rw-r--r--system/doc/design_principles/statem.xml12
1 files changed, 11 insertions, 1 deletions
diff --git a/system/doc/design_principles/statem.xml b/system/doc/design_principles/statem.xml
index 43359829b2..565b0e5274 100644
--- a/system/doc/design_principles/statem.xml
+++ b/system/doc/design_principles/statem.xml
@@ -1010,6 +1010,8 @@ do_unlock() ->
the state, you must explicitly
insert the <c>internal</c> event
or use a state transition function.
+ This is something that can be forgotten, and if you find that
+ annoying please look at the next chapter.
</p>
<p>
The following is an implementation of entry actions
@@ -1058,10 +1060,18 @@ enter(Tag, State, Data) ->
Here is the same example as the previous but instead using
the built in
<seealso marker="#state_entry_events">state entry events</seealso>.
- You will have to handle the state entry events in every state.
+ </p>
+ <p>
+ Since the state entry events are unconditionally inserted by
+ the <c>gen_statem</c> engine you can not forget to insert them
+ yourself and you will have to handle the state entry events
+ in every state.
+ </p>
+ <p>
If you want state entry code in just a few states the previous
example may be more suitable, especially to only send internal
events when entering just those few states.
+ Note: additional discipline will be required.
</p>
<p>
You can also in the previous example choose to generate