attempt at improving timeout description https://www.w3.org/Bugs/Public/show_bug.cgi?id=16298
authorAnne van Kesteren <annevk@opera.com>
Mon, 26 Mar 2012 16:46:44 +0100
changeset 55 2f60eb4d4aa4
parent 54 51e8144fcd42
child 56 ba9735a82582
attempt at improving timeout description https://www.w3.org/Bugs/Public/show_bug.cgi?id=16298
Overview.html
Overview.src.html
--- a/Overview.html	Mon Mar 26 16:36:39 2012 +0100
+++ b/Overview.html	Mon Mar 26 16:46:44 2012 +0100
@@ -1106,12 +1106,19 @@
   <dl class="domintro">
    <dt><var title="">client</var> . <code title="dom-XMLHttpRequest-timeout"><a href="#dom-xmlhttprequest-timeout">timeout</a></code></dt>
    <dd>
-    <p>The amount of milliseconds a request can take before being
-    terminated. Initially zero. Zero means there is no timeout.</p>
+    <p>Can be set to a time in milliseconds. When set to a non-zero value
+    will cause <a class="external" href="http://www.whatwg.org/specs/web-apps/current-work/multipage/fetching-resources.html#fetch" title="fetch">fetching</a> to
+    terminate after the given time has passed. When the time has passed, if
+    the <a href="#synchronous-flag">synchronous flag</a> is unset, a
+    <code title="event-xhr-timeout"><a href="#event-xhr-timeout">timeout</a></code> event will then be
+    <a class="external" href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#concept-event-dispatch" title="concept-event-dispatch">dispatched</a>,
+    or a "<code class="external"><a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#timeouterror">TimeoutError</a></code>" exception will be
+    <a class="external" href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#concept-throw" title="concept-throw">thrown</a> otherwise
+    (for the <code title="dom-XMLHttpRequest"><a href="#dom-xmlhttprequest">send()</a></code> method).
     <p>When set: throws an
     "<code class="external"><a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#invalidaccesserror">InvalidAccessError</a></code>" exception if
     the <a href="#synchronous-flag">synchronous flag</a> is set when there is an
-    associated <a href="#xmlhttprequest-document"><code>XMLHttpRequest</code> document</a>.</p>
+    associated <a href="#xmlhttprequest-document"><code>XMLHttpRequest</code> document</a>.
    </dd>
   </dl>
 
--- a/Overview.src.html	Mon Mar 26 16:36:39 2012 +0100
+++ b/Overview.src.html	Mon Mar 26 16:46:44 2012 +0100
@@ -1113,12 +1113,19 @@
   <dl class="domintro">
    <dt><var title>client</var> . <code title="dom-XMLHttpRequest-timeout">timeout</code></dt>
    <dd>
-    <p>The amount of milliseconds a request can take before being
-    terminated. Initially zero. Zero means there is no timeout.</p>
+    <p>Can be set to a time in milliseconds. When set to a non-zero value
+    will cause <span title=fetch data-anolis-spec=html>fetching</span> to
+    terminate after the given time has passed. When the time has passed, if
+    the <span>synchronous flag</span> is unset, a
+    <code title=event-xhr-timeout>timeout</code> event will then be
+    <span title=concept-event-dispatch data-anolis-spec=dom>dispatched</span>,
+    or a "<code data-anolis-spec=dom>TimeoutError</code>" exception will be
+    <span data-anolis-spec=dom title=concept-throw>thrown</span> otherwise
+    (for the <code title=dom-XMLHttpRequest>send()</code> method).
     <p>When set: throws an
     "<code data-anolis-spec=dom>InvalidAccessError</code>" exception if
     the <span>synchronous flag</span> is set when there is an
-    associated <span><code>XMLHttpRequest</code> document</span>.</p>
+    associated <span><code>XMLHttpRequest</code> document</span>.
    </dd>
   </dl>