W3C home > Mailing lists > Public > public-webapps@w3.org > April to June 2012

[Bug 17032] New: IndexedDB: Editorial - use of phrase "explicit key" is confusing

From: <bugzilla@jessica.w3.org>
Date: Thu, 10 May 2012 19:07:11 +0000
To: public-webapps@w3.org
Message-ID: <bug-17032-2927@http.www.w3.org/Bugs/Public/>
https://www.w3.org/Bugs/Public/show_bug.cgi?id=17032

           Summary: IndexedDB: Editorial - use of phrase "explicit key" is
                    confusing
           Product: WebAppsWG
           Version: unspecified
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: minor
          Priority: P2
         Component: Indexed Database API
        AssignedTo: dave.null@w3.org
        ReportedBy: jsbell@chromium.org
         QAContact: public-webapps-bugzilla@w3.org
                CC: mike@w3.org, public-webapps@w3.org


In 3.1.13 Key Generators:

>>>
When a record is stored in a object store which uses a key generator, and an
explicit key is defined, ...

NOTE: This can happen both with in-line keys, if the property of the stored
value is set, or with out-of-line keys, if an explicit key argument is
provided.
<<<

The NOTE clarifies that the normative text's use of "explicit key" applies to
both in-line keys (e.g. keyPath: "id", put({id: 1234})) and out-of-line keys
(e.g. put({}, 1234)). However, the NOTE then goes on to use the phrase
"explicit key argument" specifically with regard to out-of-line keys. This
re-use use of "explicit key" seems potentially confusing.

Suggest changing the note to read "... if a key argument is provided."

-- 
Configure bugmail: https://www.w3.org/Bugs/Public/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug.
Received on Thursday, 10 May 2012 19:07:14 GMT

This archive was generated by hypermail 2.3.1 : Tuesday, 26 March 2013 18:49:52 GMT