Skip to content

Commit 63d787c

Browse files
More help docs tweaks
1 parent 840d30e commit 63d787c

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

docs/ml_on_event_stop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ For example, if your start event handler for an action starts music playing in t
1717

1818
## Example
1919

20-
This example uses the special `unknown` option and stops playing a musical melody when any other action has a certainty above the recognition point.
20+
This example uses the special `unknown` option and stops playing a musical melody when the estimated action changes to any other action.
2121

2222
```blocks
2323
ml.onStop(ml.event.Unknown, function () {

docs/ml_on_event_stop_detailed.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ ml.onStopDetailed(ml.event.Unknown, function (duration) {
99

1010
When an action changes, the stop event handler for the previous action will run, followed by the start event handler for the next action.
1111

12+
For example, if your start event handler for an action starts music playing in the background, you could use a stop event handler to stop it.
13+
1214
The event handler is passed a `duration` parameter. The duration is the number of milliseconds since this action became the estimated action. You can use the duration parameter in your code, for example displaying it or using a variable to keep a running total.
1315

1416
## Parameters
@@ -18,7 +20,7 @@ The event handler is passed a `duration` parameter. The duration is the number o
1820

1921
## Example
2022

21-
This example uses the special `unknown` option and stops playing a musical melody when any other action has a certainty above the recognition point.
23+
This example uses the special `unknown` option and shows the duration that `unknown` was the estimated action for in seconds when the estimated action changes to any other action.
2224

2325
```blocks
2426
ml.onStopDetailed(ml.event.Unknown, function (duration) {

0 commit comments

Comments
 (0)