Fix references to reserved tokenBinding member #2014
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Commit 5f45d34 in PR #1661 changed the definition type of `CollectedClientData/tokenBinding` from "dict-member" to "dfn" to resolve Bikeshed errors about the member not existing in the `CollectedClientData` definition. However, autolinks to the reserved `tokenBinding` member still use the `{{foo}}` syntax, which is only for IDL types, so the autolinks no longer resolve. This results in Bikeshed instead pulling these autolinks as external refs from the spec database instead of internal refs, which results in an entry being added to the "terms defined elsewhere" index: "[WEBAUTHN-3] defines the following terms: tokenBinding". The changed definition type also changes the generated link anchor from "#dom-collectedclientdata-tokenbinding" to "#collectedclientdata-tokenbinding". This fixes these issues by declaring the link anchor explicitly, for backwards compatibility, and by changing the autolinks to use the `[=foo=]` syntax for autolinks to "dfn"-type definitions. This also fixes the following Bikeshed lint: ``` LINT: Unexported dfn that's not referenced locally - did you mean to export it? <dfn data-dfn-type="dfn" data-dfn-for="CollectedClientData" id="collectedclientdata-tokenbinding" data-lt="tokenBinding" data-noexport="by-default">tokenBinding<a href="#collectedclientdata-tokenbinding" class="self-link"></a></dfn> <dfn data-dfn-type="dfn" data-dfn-for="CollectedClientData" id="collectedclientdata-tokenbinding" data-lt="tokenBinding" data-noexport="by-default">tokenBinding<a href="#collectedclientdata-tokenbinding" class="self-link"></a></dfn> ```
emlun
force-pushed
the
tokenbinding-ref
branch
from
7650f7c to
2814083
Compare
agl
approved these changes
Jan 10, 2024
MasterKale
approved these changes
Jan 10, 2024
|
Ping for @selfissued to review. |
github-actions bot
added a commit
that referenced
this pull request
Feb 14, 2024
SHA: 99cbcfa Reason: push, by emlun Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Commit 5f45d34 in PR #1661 changed the definition type of
CollectedClientData/tokenBindingfrom "dict-member" to "dfn" to resolve Bikeshed errors about the member not existing in theCollectedClientDatadefinition.However, autolinks to the reserved
tokenBindingmember still use the{{foo}}syntax, which is only for IDL types, so the autolinks no longer resolve. This results in Bikeshed instead pulling these autolinks as external refs from the spec database instead of internal refs, which results in an entry being added to the "terms defined elsewhere" index: "[WEBAUTHN-3] defines the following terms: tokenBinding". The changed definition type also changes the generated link anchor from#dom-collectedclientdata-tokenbindingto#collectedclientdata-tokenbinding.This fixes these issues by declaring the link anchor explicitly, for backwards compatibility, and by changing the autolinks to use the
[=foo=]syntax for autolinks to "dfn"-type definitions.This also fixes the following Bikeshed lint:
Preview | Diff