added table with some rows based on comments from #95

Author: craigbarratt

docs/new_features.rst

@@ -38,7 +38,7 @@ The new features since 1.0.0 in master include:
 - All .py files below the ``pyscript/scripts`` directory are autoloaded, recursively.  Also, any
   file name or directory starting with ``#`` is skipped (including top-level and ``apps``), which is
   an in-place way of disabling a specific script, app or directory tree (#97).
-- ``del`` and new function ``state.delete()` can delete state variables and state variable attributes.
+- ``del`` and new function ``state.delete()`` can delete state variables and state variable attributes.
 
 Bug fixes since 1.0.0 in master include:
 

docs/reference.rst

@@ -1,6 +1,8 @@
 Reference
 =========
 
+..    include:: <mmlalias.txt>
+
 Configuration
 -------------
 
@@ -322,6 +324,22 @@ Optional arguments are:
   ``True`` at startup, while the ``state_hold_false`` logic will continue to wait until the expression
   is ``False`` for that period before the next future trigger.
 
+Here's a summary of the trigger behavior with these parameter settings:
+
+=================== ==================== ================= ========================
+``state_check_now`` ``state_hold_false`` trigger at start? trigger on state change?
+=================== ==================== ================= ========================
+default (``False``) default (``None``)   no                if expr ``True``
+default (``False``) 0                    no                if expr ``True``, only after ``False``
+default (``False``) 10                   no                if expr ``True``, only after ``False`` for |geq| 10 sec
+``True``            default (``None``)   if expr ``True``  if expr ``True``
+``True``            0                    if expr ``True``  if expr ``True``, only after ``False``
+``True``            10                   if expr ``True``  if expr ``True``, only after ``False`` for |geq| 10 sec
+=================== ==================== ================= ========================
+
+If ``state_hold`` is also specified, all the entries in the table that say "if expr ``True``"
+must remain ``True`` for that number of seconds for the trigger to occur.
+
 All state variables in HASS have string values. So you’ll have to do comparisons against string
 values or cast the variable to an integer or float. These two examples are essentially equivalent
 (note the use of single quotes inside the outer double quotes):