Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

IDBKeyRange.includes or IDBKeyRange._includes? #270

Closed
mkruisselbrink opened this issue Jun 6, 2019 · 4 comments · Fixed by #273
Closed

IDBKeyRange.includes or IDBKeyRange._includes? #270

mkruisselbrink opened this issue Jun 6, 2019 · 4 comments · Fixed by #273

Comments

@mkruisselbrink
Copy link

The IDL defines a _includes() methods, but then there is an algorithm/description for an includes() method. Which one is it supposed to be?
@inexorabletash
Copy link
Member

inexorabletash commented Jun 6, 2019 •
edited

The method is includes() in usage (and hence in the prose) but since includes is a reserved word in IDL the IDL needs to have the underscore prefix:

See: https://heycam.github.io/webidl/#idl-names

Per #226 bikeshed should handle this... seems like there's still a glitch somewhere in the cross-linking though.

@inexorabletash inexorabletash reopened this Jun 6, 2019
@inexorabletash
Copy link
Member

Might as well use this to track linking.

Not sure what's going on yet. whatwg/webidl#733 indicates the BS docs are wrong, at least...

@mkruisselbrink
Copy link
Author

Ah, interesting. Never came across that before. Good to know that that is a thing...

@inexorabletash
Copy link
Member

Bikeshed issue: speced/bikeshed#1489

In the Indexed DB 2.0 spec a note was slipped below the IDL fragment in which explained this:

https://www.w3.org/TR/IndexedDB-2/#idbkeyrange

That was done during the final review, didn't make it into 3.0. I'll copy it.

inexorabletash added a commit that referenced this issue Jun 7, 2019
@inexorabletash
Editorial: Fix _includes link, add note.
7d837ef 
"includes" is reserved word in WebIDL, so a method with that name
needs to be escaped with a leading underscore in IDL fragments.
This confuses Bikeshed (speced/bikeshed#1489) so manually
correct the link. Also, the 2.0 version of the IDB spec had a note
which gave context for this; transplant that to the 3.0 version.

Resolves #270
@inexorabletash inexorabletash mentioned this issue Jun 7, 2019
Merged
inexorabletash added a commit that referenced this issue Jun 7, 2019
@inexorabletash
Editorial: Fix _includes link, add note.
02f4c89 
"includes" is reserved word in WebIDL, so a method with that name
needs to be escaped with a leading underscore in IDL fragments.
This confuses Bikeshed (speced/bikeshed#1489) so manually
correct the link. Also, the 2.0 version of the IDB spec had a note
which gave context for this; transplant that to the 3.0 version.

Resolves #270
inexorabletash added a commit that referenced this issue Feb 1, 2021
@inexorabletash
Editorial: Fix _includes link, add note.
dd56510 
"includes" is reserved word in WebIDL, so a method with that name
needs to be escaped with a leading underscore in IDL fragments.
This confuses Bikeshed (speced/bikeshed#1489) so manually
correct the link. Also, the 2.0 version of the IDB spec had a note
which gave context for this; transplant that to the 3.0 version.

Resolves #270
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Editorial: Fix _includes link, add note. w3c/IndexedDB
2 participants
@mkruisselbrink @inexorabletash