Use <code> for references to a CDDL type
#455
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
The spec wrapped the CDDL result type of the Set Permission command in a `<pre class="cddl">` block, even though the return type is actually a reference to a CDDL type defined in WebDriver BiDi. This update wraps the block into `<code>` instead, following similar conventions used for IDL. Context for the request is that CDDL definitions defined in specs are now extracted and exposed in Webref to ease validation and integration in tools: https://github.com/w3c/webref/tree/main/ed/cddl
OrKoN
approved these changes
Dec 19, 2024
The quotes are now included in the definition.
miketaylr
approved these changes
Dec 19, 2024
| @@ -1788,7 +1788,7 @@ <h2> | |||
| </tr> | |||
| <tr data-cite="orientation-event"> | |||
| <td class="string-token"> | |||
| "[=accelerometer=]" | |||
| [="accelerometer"=] | |||
There was a problem hiding this comment.
Seems weird to me to have the quotes be part of the definition, but I see that's what they did. 🤷
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.
The spec wrapped the CDDL result type of the Set Permission command in a
<pre class="cddl">block, even though the return type is actually a reference to a CDDL type defined in WebDriver BiDi.This update wraps the block into
<code>instead, following similar conventions used for IDL.Context for the request is that CDDL definitions defined in specs are now extracted and exposed in Webref to ease validation and integration in tools: https://github.com/w3c/webref/tree/main/ed/cddl
Preview | Diff