W3C home > Mailing lists > Public > public-webapi@w3.org > May 2008

[XMLHttpRequest] LC comments

From: Marcos Caceres <marcosscaceres@gmail.com>
Date: Tue, 27 May 2008 11:15:36 +1000
Message-ID: <b21a10670805261815y5800907cidf98bc52c9d66115@mail.gmail.com>
To: "Anne van Kesteren" <annevk@opera.com>, "Web API WG" <public-webapi@w3.org>

If it's not too late, some really minor editorial comments on
XMLHTTPRequest Editor's Draft 16 May 2008.

---
The following instances of the word "which" should be changed for the
word "that":

The OPENED state has an associated send() flag which indicates ...

The DONE state has an associated error flag which indicates ...

If there is no Content-Type header or there is a Content-Type header
which contains ...

If there is a Content-Type header which contains a text/html MIME ...
---

A comma is missing after the word object in the following statement:

These exceptions are all part of the group ExceptionCode and use the
DOMException object which is defined in DOM Level 3 Core.

Should be:

These exceptions are all part of the group ExceptionCode and use the
DOMException object, which is defined in DOM Level 3 Core.

---

The word "simply" should be removed from the following note:

Note: authors are encouraged to simply encode their resources using UTF-8.

---
This sentence is missing a subject (the xmlhttprequest object):

On getting the attribute must return the value of the constant
corresponding to the object's current state.

Change to:

On getting the attribute, the instance must return the value of the
constant corresponding to the object's current state.

---

Lastly, the word "null" sometimes appears in quotes ("null") and
sometimes appears marked up between <code> elements. If this is
intentional, then ignore this comment. Otherwise, where the string
"null" is not being returned, null should probably be marked up with
<code> to avoid the reader from expecting that the string "null" is
being returned (and vice versa).

---

Nice work, btw.
-- 
Marcos Caceres
http://datadriven.com.au
Received on Tuesday, 27 May 2008 01:16:26 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Tuesday, 27 May 2008 01:16:28 GMT