868697 - Documentation incorrect for nsIXMLHttpRequestEventTarget timeout

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: API: DOM, defect)

Description

[Scott Turner]

User Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
Build ID: 20130409194949

Steps to reproduce:

The documentation for XMLHttpRequest is confusing.  It doesn't clearly explain what happens when a request reaches its timeout value.  It's reasonable to assume that timeout would raise an "error" event or possibly an "abort" event.  In fact, it raises a "timeout" event.  This behavior isn't documented anywhere.



Expected results:

Change https://developer.mozilla.org/en-US/docs/DOM/XMLHttpRequest and/or https://developer.mozilla.org/en-US/docs/XPCOM_Interface_Reference/nsIXMLHttpRequestEventTarget to indicate that timeout causes a "timeout" event without any other event.

Comment 1

[chandrakm]

Added this "when a request reaches its timeout value  a "timeout" event is raised." in the help page for XMLHttpRequest at  https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest

Comment 2

[chandrakm]

I am not sure, if i have the permission to change this bug status to resolved, some one who has the permission can change this to resolved.

Comment 3

[David Bruant]

(In reply to chandrakm from comment #2)
> I am not sure, if i have the permission to change this bug status to
> resolved, some one who has the permission can change this to resolved.
Yep. Thanks for your contribution.

Comment 4

[Scott Turner]

Thanks, Chandra!