W3C home > Mailing lists > Public > public-webapi@w3.org > April 2006

[comment] XMLHttpRequest Object - testable assertions

From: Karl Dubost <karl@w3.org>
Date: Wed, 12 Apr 2006 15:45:00 +0900
Message-Id: <32C67F5A-C74C-4D81-8C9F-5BF1A9545893@w3.org>
To: public-webapi@w3.org

Hi,

This is a QA Review comment for "The XMLHttpRequest Object"
http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060405/
Wed, 05 Apr 2006 17:02:33 GMT
First WD


It would be cool to review completely your document for the  
testability and clarity of your assertions. For example, let's take  
the very first one in the document.

[[[
The following interface MAY be used to allow scripts to  
programmatically connect to their originating server via HTTP.
]]]

-- The XMLHttpRequest Object
http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060405/#xmlhttprequest
Wed, 05 Apr 2006 17:02:33 GMT


"following interface" is the name of the feature? I know it's not,  
but it means that the assertion is valid only in the context of  
reading the full document and it might make your life difficult when  
the WG will design a Test Suite. It's also very hard to read because  
the term "interface XMLHttpRequest" comes a lot after.

The previous sentence would become:

The <code>XMLHttpRequest</code> interface MAY be used to allow  
scripts to programmatically connect to their originating server via  
HTTP.






-- 
Karl Dubost - http://www.w3.org/People/karl/
W3C Conformance Manager, QA Activity Lead
   QA Weblog - http://www.w3.org/QA/
      *** Be Strict To Be Cool ***
Received on Wednesday, 12 April 2006 06:45:43 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Tuesday, 8 January 2008 14:18:54 GMT