Skip to content

Commit

Permalink
Editorial: Fix links/phrasing in non-normative text about queries
Browse files Browse the repository at this point in the history
Copy/pasta and repeated edits had muddled the non-normative text
around various methods explaining the query parameter, namely "The
query parameter... identifying the record/records/values/keys..." was
inconsistent in phrasing. plurals and link targets. This cleans it up,
resulting in:

IDBObjectStore.delete()     - [object-store] records
IDBObjectStore.get()        - [object-store] record value
IDBObjectStore.getKey()     - [object-store] record key
IDBObjectStore.getAll()     - [object-store] record values
IDBObjectStore.getAllKeys() - [object-store] record keys
IDBObjectStore.count()      - [object-store] records

IDBIndex.get()              - [index] referenced value
IDBIndex.getKey()           - [object-store] record key
IDBIndex.getAll()           - [index] referenced values
IDBIndex.getAllKeys()       - [object-store] record keys
IDBIndex.count()            - [index] records

... where [blah] above is disambiguating the link target just in this
commit comment, not in the actual text.

As a reminder, an index record's *value* is a *key* in the referenced
object store; since this is downright confusing and we're just talking
about informative text, the link above is to an object store's record
key.
  • Loading branch information
inexorabletash committed Apr 13, 2023
1 parent c435314 commit a6a3acc
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions index.bs
Original file line number Diff line number Diff line change
Expand Up @@ -3020,7 +3020,7 @@ The <dfn method for=IDBObjectStore>delete(|query|)</dfn> method steps are:

<aside class=note>
The |query| parameter can be a [=/key=] or [=/key range=] (an {{IDBKeyRange}})
identifying the [=object-store/records=] keys to be
identifying the [=object-store/records=] to be
deleted.
</aside>

Expand Down Expand Up @@ -3130,7 +3130,7 @@ The <dfn method for=IDBObjectStore>get(|query|)</dfn> method steps are:

<aside class=note>
The |query| parameter can be a [=/key=] or [=/key range=] (an {{IDBKeyRange}})
identifying the [=object-store/record=] to be retrieved. If a
identifying the [=object-store/record=] value to be retrieved. If a
range is specified, the method retrieves the first existing value in
that range.
</aside>
Expand Down Expand Up @@ -3235,7 +3235,7 @@ The <dfn method for=IDBObjectStore>getAllKeys(|query|, |count|)</dfn> method ste

<aside class=note>
The |query| parameter can be a [=/key=] or [=/key range=] (an {{IDBKeyRange}})
identifying the [=object-store/records=] keys to be retrieved. If null or not
identifying the [=object-store/record=] keys to be retrieved. If null or not
given, an [=unbounded key range=] is used. If |count| is specified
and there are more than |count| keys in range, only the first |count|
will be retrieved.
Expand Down Expand Up @@ -3268,7 +3268,7 @@ The <dfn method for=IDBObjectStore>count(|query|)</dfn> method steps are:

<aside class=note>
The |query| parameter can be a [=/key=] or [=/key range=] (an {{IDBKeyRange}})
identifying the [=object-store/records=] keys to be counted. If null or not
identifying the [=object-store/records=] to be counted. If null or not
given, an [=unbounded key range=] is used.
</aside>

Expand Down Expand Up @@ -3799,7 +3799,7 @@ The <dfn method for=IDBIndex>get(|query|)</dfn> method steps are:

<aside class=note>
The |query| parameter can be a [=/key=] or [=/key range=] (an {{IDBKeyRange}})
identifying the [=object-store/record=] to be retrieved. If a
identifying the [=index/referenced value=] to be retrieved. If a
range is specified, the method retrieves the first existing record in
that range.
</aside>
Expand Down Expand Up @@ -3870,7 +3870,7 @@ The <dfn method for=IDBIndex>getAll(|query|, |count|)</dfn> method steps are:

<aside class=note>
The |query| parameter can be a [=/key=] or [=/key range=] (an {{IDBKeyRange}})
identifying the [=object-store/record=] keys to be retrieved. If null or not given,
identifying the [=index/referenced values=] to be retrieved. If null or not given,
an [=unbounded key range=] is used. If |count| is specified and
there are more than |count| records in range, only the first |count|
will be retrieved.
Expand Down Expand Up @@ -3903,7 +3903,7 @@ The <dfn method for=IDBIndex>getAllKeys(|query|, |count|)</dfn> method steps are

<aside class=note>
The |query| parameter can be a [=/key=] or [=/key range=] (an {{IDBKeyRange}})
identifying the [=object-store/records=] keys to be retrieved. If null or not
identifying the [=object-store/record=] keys to be retrieved. If null or not
given, an [=unbounded key range=] is used. If |count| is specified
and there are more than |count| keys in range, only the first |count|
will be retrieved.
Expand Down Expand Up @@ -3936,7 +3936,7 @@ The <dfn method for=IDBIndex>count(|query|)</dfn> method steps are:

<aside class=note>
The |query| parameter can be a [=/key=] or [=/key range=] (an {{IDBKeyRange}})
identifying the [=object-store/records=] keys to be counted. If null or not
identifying the [=index/records=] to be counted. If null or not
given, an [=unbounded key range=] is used.
</aside>

Expand Down

0 comments on commit a6a3acc

Please sign in to comment.