[DOC] web_cohort: documents mode attribute

Closes #25512
2018-07-04 16:42:08 +02:00
parent 4206aba48b
commit 0f48701384
1 changed files with 5 additions and 0 deletions
@@ -1336,6 +1336,11 @@ attributes:
    A valid date or datetime field. This field is understood by the view as the
    end date of a record.  This is the field that will determine the churn.

+- ``mode`` (optional)
+    A string to describe the mode. It should be either 'churn' or
+    'retention' (default). Churn mode will start at 0% and accumulate over time
+    whereas retention will start at 100% and decrease over time.
+
 - ``interval`` (optional)
    A string to describe a time interval. It should be 'day', 'week', 'month''
    (default) or 'year'.