Add optional descriptions as internal (for now) documentation (web-platform-dx#598)

foolip · web-flow · commit 54f5d8e53f5d · 2024-02-13T09:36:54.000+07:00
diff --git a/feature-group-definitions/input-event.yml b/feature-group-definitions/input-event.yml
@@ -1,4 +1,5 @@
 name: input event
+description: The `input` event fires when a form control changes or an element with the `contenteditable` attribute changes.
 spec: https://w3c.github.io/uievents/#event-type-input
 caniuse: input-event
 status:
diff --git a/feature-group-definitions/webvtt.yml b/feature-group-definitions/webvtt.yml
@@ -1,4 +1,5 @@
 name: WebVTT
+description: WebVTT is a captions and subtitles format. WebVTT files are loaded using the `<track>` element, and the `VTTCue` API can be used to create or update cues dynamically.
 spec: https://w3c.github.io/webvtt/
 caniuse: webvtt
 usage_stats: https://chromestatus.com/metrics/feature/timeline/popularity/409
diff --git a/index.ts b/index.ts
@@ -12,9 +12,8 @@ const monthsFromBaselineLowToHigh = 30;
 
 // Some FeatureData keys aren't (and may never) be ready for publishing.
 // They're not part of the public schema (yet).
-// They'll be removed.
 const omittables = [
-    // "compat_features"
+    "description"
 ]
 
 function scrub(data: FeatureData) {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`name: input event`
	`2`	+description: The `input` event fires when a form control changes or an element with the `contenteditable` attribute changes.
`2`	`3`	`spec: https://w3c.github.io/uievents/#event-type-input`
`3`	`4`	`caniuse: input-event`
`4`	`5`	`status:`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`name: WebVTT`
	`2`	+description: WebVTT is a captions and subtitles format. WebVTT files are loaded using the `<track>` element, and the `VTTCue` API can be used to create or update cues dynamically.
`2`	`3`	`spec: https://w3c.github.io/webvtt/`
`3`	`4`	`caniuse: webvtt`
`4`	`5`	`usage_stats: https://chromestatus.com/metrics/feature/timeline/popularity/409`
Original file line number	Diff line number	Diff line change
`@@ -12,9 +12,8 @@ const monthsFromBaselineLowToHigh = 30;`
`12`	`12`
`13`	`13`	`// Some FeatureData keys aren't (and may never) be ready for publishing.`
`14`	`14`	`// They're not part of the public schema (yet).`
`15`		`-// They'll be removed.`
`16`	`15`	`const omittables = [`
`17`		`- // "compat_features"`
	`16`	`+ "description"`
`18`	`17`	`]`
`19`	`18`
`20`	`19`	`function scrub(data: FeatureData) {`