Fix descriptions of entries based upon data guidelines (mdn#4790)

Lo236816 · Sep 10, 2019 · b548b3b · b548b3b
1 parent 67e99b8
commit b548b3b
Show file tree

Hide file tree

Showing 37 changed files with 52 additions and 31 deletions.
diff --git a/api/AnimationEvent.json b/api/AnimationEvent.json
@@ -101,6 +101,7 @@
       "AnimationEvent": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/AnimationEvent/AnimationEvent",
+          "description": "<code>AnimationEvent()</code> constructor",
           "support": {
             "chrome": {
               "version_added": "43"

diff --git a/api/AnimationPlaybackEvent.json b/api/AnimationPlaybackEvent.json
@@ -50,6 +50,7 @@
       "AnimationPlaybackEvent": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/AnimationPlaybackEvent/AnimationPlaybackEvent",
+          "description": "<code>AnimationPlaybackEvent()</code> constructor",
           "support": {
             "chrome": {
               "version_added": true

diff --git a/api/CSSPerspective.json b/api/CSSPerspective.json
@@ -50,7 +50,7 @@
       "CSSPerspective": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/CSSPerspective/CSSPerspective",
-          "description": "<code>CSSPerspective()</code>",
+          "description": "<code>CSSPerspective()</code> constructor",
           "support": {
             "chrome": {
               "version_added": "66"

diff --git a/api/CSSPositionValue.json b/api/CSSPositionValue.json
@@ -50,7 +50,7 @@
       "CSSPositionValue": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/CSSPositionValue/CSSPositionValue",
-          "description": "<code>CSSPositionValue()</code>",
+          "description": "<code>CSSPositionValue()</code> constructor",
           "support": {
             "chrome": {
               "version_added": "66"

diff --git a/api/DOMMatrix.json b/api/DOMMatrix.json
@@ -92,7 +92,7 @@
       },
       "worker_support": {
         "__compat": {
-          "description": "Support in <a href='https://developer.mozilla.org/docs/Web/API/Web_Workers_API'>web workers</a>",
+          "description": "Available in workers",
           "support": {
             "chrome": {
               "version_added": "61"

diff --git a/api/DOMMatrixReadOnly.json b/api/DOMMatrixReadOnly.json
@@ -2035,7 +2035,7 @@
       },
       "worker_support": {
         "__compat": {
-          "description": "Support in <a href='https://developer.mozilla.org/docs/Web/API/Web_Workers_API'>web workers</a>",
+          "description": "Available in workers",
           "support": {
             "chrome": {
               "version_added": "57"

diff --git a/api/Document.json b/api/Document.json
@@ -9021,8 +9021,8 @@
       },
       "selectionchange_event": {
         "__compat": {
-          "mdn_url": "https://developer.mozilla.org/docs/Web/API/Document/selectstart_event",
-          "description": "<code>selectstart</code> event",
+          "mdn_url": "https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event",
+          "description": "<code>selectionchange</code> event",
           "support": {
             "chrome": {
               "version_added": true

diff --git a/api/ExtendableMessageEvent.json b/api/ExtendableMessageEvent.json
@@ -51,6 +51,7 @@
       "ExtendableMessageEvent": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/ExtendableMessageEvent/ExtendableMessageEvent",
+          "description": "<code>ExtendableMessageEvent()</code> constructor",
           "support": {
             "chrome": {
               "version_added": null

diff --git a/api/FederatedCredential.json b/api/FederatedCredential.json
@@ -47,6 +47,7 @@
       "FederatedCredential": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/FederatedCredential/FederatedCredential",
+          "description": "<code>FederatedCredential()</code> constructor",
           "support": {
             "chrome": {
               "version_added": "51"

diff --git a/api/FileReaderSync.json b/api/FileReaderSync.json
@@ -278,7 +278,7 @@
       },
       "worker_support": {
         "__compat": {
-          "description": "Only available in workers",
+          "description": "Available in workers",
           "support": {
             "chrome": {
               "version_added": true

diff --git a/api/GestureEvent.json b/api/GestureEvent.json
@@ -50,6 +50,7 @@
       "GestureEvent": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/GestureEvent/GestureEvent",
+          "description": "<code>GestureEvent()</code> constructor",
           "support": {
             "chrome": {
               "version_added": false

diff --git a/api/InstallEvent.json b/api/InstallEvent.json
@@ -50,7 +50,7 @@
       },
       "InstallEvent": {
         "__compat": {
-          "description": "<code>InstallEvent()</code> constructor.",
+          "description": "<code>InstallEvent()</code> constructor",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/InstallEvent/InstallEvent",
           "support": {
             "chrome": {

diff --git a/api/KeyboardEvent.json b/api/KeyboardEvent.json
@@ -242,6 +242,7 @@
       "KeyboardEvent": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/KeyboardEvent/KeyboardEvent",
+          "description": "<code>KeyboardEvent()</code> constructor",
           "support": {
             "chrome": {
               "version_added": true

diff --git a/api/KeyframeEffect.json b/api/KeyframeEffect.json
@@ -49,8 +49,8 @@
       },
       "KeyframeEffect": {
         "__compat": {
-          "description": "Clone constructor (2nd type of constructor)",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/KeyframeEffect/KeyframeEffect",
+          "description": "<code>KeyframeEffect()</code> constructor",
           "support": {
             "chrome": {
               "version_added": true

diff --git a/api/MIDIAccess.json b/api/MIDIAccess.json
@@ -146,6 +146,7 @@
       "statechange_event": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/MIDIAccess/outputs",
+          "description": "<code>statechange</code> event",
           "support": {
             "chrome": {
               "version_added": "43"

diff --git a/api/MIDIInput.json b/api/MIDIInput.json
@@ -50,6 +50,7 @@
       "midimessage_event": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/MIDIInput/midimessage_event",
+          "description": "<code>midimessage</code> event",
           "support": {
             "chrome": {
               "version_added": "43"

diff --git a/api/MIDIPort.json b/api/MIDIPort.json
@@ -365,6 +365,7 @@
       "statechange_event": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/MIDIPort/statechange_event",
+          "description": "<code>statechange</code> event",
           "support": {
             "chrome": {
               "version_added": "43"

diff --git a/api/MediaMetadata.json b/api/MediaMetadata.json
@@ -49,7 +49,7 @@
       },
       "MediaMetadata": {
         "__compat": {
-          "description": "<code>MediaMetadata()</code> constructor.",
+          "description": "<code>MediaMetadata()</code> constructor",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/MediaMetadata/MediaMetadata",
           "support": {
             "chrome": {

diff --git a/api/MediaSource.json b/api/MediaSource.json
@@ -92,6 +92,7 @@
       "MediaSource": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/MediaSource/MediaSource",
+          "description": "<code>MediaSource()</code> constructor",
           "support": {
             "chrome": [
               {

diff --git a/api/MediaStream.json b/api/MediaStream.json
@@ -147,6 +147,7 @@
       "active_event": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/MediaStream/active_event",
+          "description": "<code>active</code> event",
           "support": {
             "chrome": {
               "version_added": "45"
@@ -645,6 +646,7 @@
       "inactive_event": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/MediaStream/inactive_event",
+          "description": "<code>inactive</code> event",
           "support": {
             "chrome": {
               "version_added": "45"

diff --git a/api/MessageChannel.json b/api/MessageChannel.json
@@ -50,6 +50,7 @@
       "MessageChannel": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/MessageChannel/MessageChannel",
+          "description": "<code>MessageChannel()</code> constructor",
           "support": {
             "chrome": {
               "version_added": "4"

diff --git a/api/MessageEvent.json b/api/MessageEvent.json
@@ -50,6 +50,7 @@
       "MessageEvent": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/MessageEvent/MessageEvent",
+          "description": "<code>MessageEvent()</code> constructor",
           "support": {
             "chrome": {
               "version_added": "1"

diff --git a/api/NavigatorLanguage.json b/api/NavigatorLanguage.json
@@ -153,7 +153,7 @@
       },
       "worker_support": {
         "__compat": {
-          "description": "Support on <code>WorkerNavigator</code>",
+          "description": "Available in workers",
           "support": {
             "chrome": {
               "version_added": null

diff --git a/api/NavigatorOnLine.json b/api/NavigatorOnLine.json
@@ -102,7 +102,7 @@
       },
       "worker_support": {
         "__compat": {
-          "description": "Support on <code>WorkerNavigator</code>",
+          "description": "Available in workers",
           "support": {
             "chrome": {
               "version_added": null

diff --git a/api/PasswordCredential.json b/api/PasswordCredential.json
@@ -47,6 +47,7 @@
       "PasswordCredential": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/PasswordCredential/PasswordCredential",
+          "description": "<code>PasswordCredential()</code> constructor",
           "support": {
             "chrome": {
               "version_added": "51"

diff --git a/api/RTCDTMFToneChangeEvent.json b/api/RTCDTMFToneChangeEvent.json
@@ -49,7 +49,7 @@
       },
       "RTCDTMFToneChangeEvent": {
         "__compat": {
-          "description": "<code>RTCDTMFToneChangeEvent()</code>",
+          "description": "<code>RTCDTMFToneChangeEvent()</code> constructor",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/RTCDTMFToneChangeEvent/RTCDTMFToneChangeEvent",
           "support": {
             "chrome": {

diff --git a/api/RTCIceCandidate.json b/api/RTCIceCandidate.json
@@ -49,7 +49,7 @@
       },
       "RTCIceCandidate": {
         "__compat": {
-          "description": "<code>RTCIceCandidate()</code>",
+          "description": "<code>RTCIceCandidate()</code> constructor",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/RTCIceCandidate/RTCIceCandidate",
           "support": {
             "chrome": {

diff --git a/api/RTCPeerConnection.json b/api/RTCPeerConnection.json
@@ -77,7 +77,7 @@
       },
       "RTCPeerConnection": {
         "__compat": {
-          "description": "RTCPeerConnection()",
+          "description": "<code>RTCPeerConnection()</code> constructor",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/RTCPeerConnection/RTCPeerConnection",
           "support": {
             "chrome": {

diff --git a/api/RTCPeerConnectionIceEvent.json b/api/RTCPeerConnectionIceEvent.json
@@ -70,7 +70,7 @@
       },
       "RTCPeerConnectionIceEvent": {
         "__compat": {
-          "description": "<code>RTCPeerConnectionIceEvent()</code> constructor.",
+          "description": "<code>RTCPeerConnectionIceEvent()</code> constructor",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/RTCPeerConnectionIceEvent/RTCPeerConnectionIceEvent",
           "support": {
             "chrome": {

diff --git a/api/SecurityPolicyViolationEvent.json b/api/SecurityPolicyViolationEvent.json
@@ -1010,7 +1010,7 @@
       },
       "worker_support": {
         "__compat": {
-          "description": "<code>SecurityPolicyViolationEvent</code> support in workers",
+          "description": "Available in workers",
           "support": {
             "chrome": {
               "version_added": "56"

diff --git a/api/SpeechRecognition.json b/api/SpeechRecognition.json
@@ -155,7 +155,7 @@
       },
       "audioend_event": {
         "__compat": {
-          "description": "<code>audioend/code> event",
+          "description": "<code>audioend</code> event",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/SpeechRecognition/audioend_event",
           "support": {
             "chrome": {
@@ -201,7 +201,7 @@
       },
       "audiostart_event": {
         "__compat": {
-          "description": "<code>audiostart/code> event",
+          "description": "<code>audiostart</code> event",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/SpeechRecognition/audiostart_event",
           "support": {
             "chrome": {
@@ -298,7 +298,7 @@
       },
       "end_event": {
         "__compat": {
-          "description": "<code>end/code> event",
+          "description": "<code>end</code> event",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/SpeechRecognition/end_event",
           "support": {
             "chrome": {
@@ -344,7 +344,7 @@
       },
       "error_event": {
         "__compat": {
-          "description": "<code>error/code> event",
+          "description": "<code>error</code> event",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/SpeechRecognition/error_event",
           "support": {
             "chrome": {
@@ -594,7 +594,7 @@
       },
       "nomatch_event": {
         "__compat": {
-          "description": "<code>nomatch/code> event",
+          "description": "<code>nomatch</code> event",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/SpeechRecognition/nomatch_event",
           "support": {
             "chrome": {
@@ -1201,7 +1201,7 @@
       },
       "result_event": {
         "__compat": {
-          "description": "<code>result/code> event",
+          "description": "<code>result</code> event",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/SpeechRecognition/result_event",
           "support": {
             "chrome": {
@@ -1298,7 +1298,7 @@
       },
       "soundend_event": {
         "__compat": {
-          "description": "<code>soundend/code> event",
+          "description": "<code>soundend</code> event",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/SpeechRecognition/soundend_event",
           "support": {
             "chrome": {
@@ -1344,7 +1344,7 @@
       },
       "soundstart_event": {
         "__compat": {
-          "description": "<code>soundstart/code> event",
+          "description": "<code>soundstart</code> event",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/SpeechRecognition/soundstart_event",
           "support": {
             "chrome": {
@@ -1390,7 +1390,7 @@
       },
       "speechend_event": {
         "__compat": {
-          "description": "<code>speechend/code> event",
+          "description": "<code>speechend</code> event",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/SpeechRecognition/speechend_event",
           "support": {
             "chrome": {
@@ -1436,7 +1436,7 @@
       },
       "speechstart_event": {
         "__compat": {
-          "description": "<code>speechstart/code> event",
+          "description": "<code>speechstart</code> event",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/SpeechRecognition/speechstart_event",
           "support": {
             "chrome": {
@@ -1533,7 +1533,7 @@
       },
       "start_event": {
         "__compat": {
-          "description": "<code>start/code> event",
+          "description": "<code>start</code> event",
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/SpeechRecognition/start_event",
           "support": {
             "chrome": {

diff --git a/api/TextEncoder.json b/api/TextEncoder.json
@@ -320,7 +320,7 @@
       },
       "worker_support": {
         "__compat": {
-          "description": "Available in Web Workers",
+          "description": "Available in workers",
           "support": {
             "chrome": {
               "version_added": "38"

diff --git a/api/TextTrackCue.json b/api/TextTrackCue.json
@@ -98,6 +98,7 @@
       "enter_event": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/TextTrackCue/enter_event",
+          "description": "<code>enter</code> event",
           "support": {
             "chrome": {
               "version_added": "18"
@@ -146,6 +147,7 @@
       "exit_event": {
         "__compat": {
           "mdn_url": "https://developer.mozilla.org/docs/Web/API/TextTrackCue/exit_event",
+          "description": "<code>exit</code> event",
           "support": {
             "chrome": {
               "version_added": "18"