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.

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

IDL/dfn of terms with underscores not autolinking as expected #1489

Open
inexorabletash opened this issue Jun 7, 2019 · 1 comment
Open

Comments

@inexorabletash
Copy link

When needing to use underscores to escape IDL keywords, the docs seemingly indicate this should work:

<xmp class=idl>
interface Foo {
  void _bar(any x);
};
</xmp>

The <dfn method for=Foo>bar(|x|)</dfn> method...

... but I'm seeing the IDL fragment define a #dom-foo-_bar id rather than autolinking to the #dom-idbkeyrange-includes id defined by the prose.

@inexorabletash
Copy link
Author

inexorabletash commented Jun 7, 2019

I was able to work around with:

The <dfn method for=Foo lt="_bar(x)|bar(x)">bar(|x|)</dfn> method...

inexorabletash added a commit to w3c/IndexedDB that referenced this issue Jun 7, 2019
"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 to w3c/IndexedDB that referenced this issue Jun 7, 2019
"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 to w3c/IndexedDB that referenced this issue Feb 1, 2021
"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
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant