PISTON-542: add documentation of cf_acdc_wait_time module purpose

2600hz · Mar 1, 2018 · 695eaba · 695eaba
1 parent 4b85a66
commit 695eaba
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/applications/acdc/src/cf_acdc_wait_time.erl b/applications/acdc/src/cf_acdc_wait_time.erl
@@ -1,6 +1,8 @@
 %%%-----------------------------------------------------------------------------
 %%% @copyright (C) 2018-, Voxter Communications Inc
-%%% @doc Data: {
+%%% @doc Handles branching the callflow based on the current average wait time
+%%% of a queue
+%%% Data: {
 %%%   "id":"queue id"
 %%% }
 %%%

diff --git a/applications/callflow/doc/acdc_wait_time.md b/applications/callflow/doc/acdc_wait_time.md
@@ -2,6 +2,9 @@
 
 ### About Acdc Wait Time
 
+Handles branching the callflow based on the current average wait time of a queue.
+Branch keys are integer-convertible binaries (e.g. `<<"60">>`) that represent wait time thresholds in seconds. The default branch is represented by the `_` key. The branch with the highest threshold which the queue's current average wait time exceeds is the branch followed in the callflow's execution. If none are exceeded, the default branch is followed.
+
 #### Schema
 
 Validator for the acdc_wait_time callflow's data object