Add "definedIn" property to dfns extract #446
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 `definedIn` property captures the context under which the definition appears in the specification. Value may be one of: - "dt": appears in a <dt> - "pre": appears in a <pre> - "table": appears in a <table> - "heading": appears in one of <h1>, <h2>, <h3>, <h4>, <h5>, <h6> - "note": appears in a section flagged with a `note` class - "example": appears in a section flagged with an `example` class - "prose": appears elsewhere, typically in a paragraph. This information is meant to be used for analysis purpose, e.g. to identify cases where a definition used by a spec is incorrectly defined in a Note, or where an IDL definition appears in an IDL block instead of in the prose of the specification. Other projects may also perhaps use that information, likely in combination with `type`, to assess whether they should link to the definition itself or to the section that contains the definition. The classification may evolve based on feedback.
dontcallmedom
approved these changes
Nov 16, 2020
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
definedInproperty captures the context under which the definition appears in the specification. Value may be one of:<dt><pre><table><h1>,<h2>,<h3>,<h4>,<h5>,<h6>noteclassexampleclassThis information is meant to be used for analysis purpose, e.g. to identify cases where a definition used by a spec is incorrectly defined in a Note, or where an IDL definition appears in an IDL block instead of in the prose of the specification.
Other projects may also perhaps use that information, likely in combination with
type, to assess whether they should link to the definition itself or to the section that contains the definition. See related discussion in mdn/browser-compat-data#6765 (comment)The classification may evolve based on feedback.