From 1fc78bf4b304881b09ef24af40c1b1b494e2bde5 Mon Sep 17 00:00:00 2001
From: Christian Helbling
Date: Fri, 6 Jan 2017 14:43:50 +0100
Subject: add illustration for it::error

---
 it.class | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'it.class')

diff --git a/it.class b/it.class
index 0b4f44a..95c91e5 100644
--- a/it.class
+++ b/it.class
@@ -127,6 +127,15 @@ static function timerlog($label = '')
  * @param $p['failcount'] give number of consecutive okstate failures needed for creating an error [2]
  * @param $p['omitdebuginfo'] value 1 omits long stack and var dumps, value 2 also omits trace and url
  * @return always null (so users can return it::error() in error cases)
+ * EXAMPLES (m: mail, x: no mail)
+ *   time        ---|graceperiod|timewindow|
+ *                                   |graceperiod|timewindow|--.
+ *                                                             |graceperiod|timewindow|------>
+ *   id             x  x     x       m    x   x                x     x
+ *
+ *   time        ---|blockmail|--|blockmail|---->
+ *   blockmailid    m  x     x   m   x
+ *
  */
 static function error($p = array())
 {
-- 
cgit v1.2.3