Skip to content

Commit

Permalink
Add _static suffix for static methods and properties (#26482)
Browse files Browse the repository at this point in the history
* Add _static suffix for static methods and properties

* Fix up front matter

* Update metadocs
  • Loading branch information
wbamberg authored Apr 28, 2023
1 parent 67114db commit f29d8a6
Show file tree
Hide file tree
Showing 102 changed files with 298 additions and 176 deletions.
118 changes: 80 additions & 38 deletions files/en-us/_redirects.txt

Large diffs are not rendered by default.

60 changes: 30 additions & 30 deletions files/en-us/_wikihistory.json
Original file line number Diff line number Diff line change
Expand Up @@ -21033,7 +21033,7 @@
"modified": "2020-10-30T18:47:53.251Z",
"contributors": ["krosylight", "Rumyra"]
},
"Web/API/BarcodeDetector/getSupportedFormats": {
"Web/API/BarcodeDetector/getSupportedFormats_static": {
"modified": "2020-10-30T18:49:28.688Z",
"contributors": ["krosylight", "Rumyra"]
},
Expand Down Expand Up @@ -22342,7 +22342,7 @@
"kscarfone"
]
},
"Web/API/CSS/escape": {
"Web/API/CSS/escape_static": {
"modified": "2020-10-15T21:26:49.626Z",
"contributors": [
"ExE-Boss",
Expand All @@ -22358,19 +22358,19 @@
"ziyunfei"
]
},
"Web/API/CSS/factory_functions": {
"Web/API/CSS/factory_functions_static": {
"modified": "2020-10-15T22:23:16.942Z",
"contributors": ["estelle"]
},
"Web/API/CSS/paintWorklet": {
"Web/API/CSS/paintWorklet_static": {
"modified": "2020-10-15T22:14:39.186Z",
"contributors": ["ExE-Boss", "estelle", "jpmedley", "Sheppy"]
},
"Web/API/CSS/registerProperty": {
"Web/API/CSS/registerProperty_static": {
"modified": "2020-10-15T22:23:15.780Z",
"contributors": ["Wind1808", "harrylewis", "chrisdavidmills", "estelle"]
},
"Web/API/CSS/supports": {
"Web/API/CSS/supports_static": {
"modified": "2020-10-15T21:21:12.267Z",
"contributors": [
"mfuji09",
Expand Down Expand Up @@ -22658,7 +22658,7 @@
"modified": "2020-10-15T22:19:16.519Z",
"contributors": ["jpmedley"]
},
"Web/API/CSSNumericValue/parse": {
"Web/API/CSSNumericValue/parse_static": {
"modified": "2020-10-15T22:19:16.343Z",
"contributors": ["jpmedley"]
},
Expand Down Expand Up @@ -26115,7 +26115,7 @@
"modified": "2020-10-15T21:36:26.672Z",
"contributors": ["Sheppy", "fscholz", "rolfedh", "chrisdavidmills"]
},
"Web/API/DOMPoint/fromPoint": {
"Web/API/DOMPoint/fromPoint_static": {
"modified": "2020-10-15T22:06:38.613Z",
"contributors": ["Sheppy"]
},
Expand Down Expand Up @@ -26150,7 +26150,7 @@
"modified": "2020-10-15T22:06:35.807Z",
"contributors": ["Sheppy"]
},
"Web/API/DOMPointReadOnly/fromPoint": {
"Web/API/DOMPointReadOnly/fromPoint_static": {
"modified": "2020-10-15T22:06:36.625Z",
"contributors": ["Zearin_Galaurum", "Sheppy"]
},
Expand Down Expand Up @@ -26264,7 +26264,7 @@
"chrisdavidmills"
]
},
"Web/API/DOMRectReadOnly/fromRect": {
"Web/API/DOMRectReadOnly/fromRect_static": {
"modified": "2020-10-15T21:53:07.764Z",
"contributors": [
"idreyn",
Expand Down Expand Up @@ -43020,7 +43020,7 @@
"jswisher"
]
},
"Web/API/IDBKeyRange/bound": {
"Web/API/IDBKeyRange/bound_static": {
"modified": "2020-10-15T21:25:21.421Z",
"contributors": [
"sideshowbarker",
Expand Down Expand Up @@ -43051,7 +43051,7 @@
"chrisdavidmills"
]
},
"Web/API/IDBKeyRange/lowerBound": {
"Web/API/IDBKeyRange/lowerBound_static": {
"modified": "2020-12-02T14:58:14.913Z",
"contributors": [
"inexorabletash",
Expand All @@ -43076,7 +43076,7 @@
"chrisdavidmills"
]
},
"Web/API/IDBKeyRange/only": {
"Web/API/IDBKeyRange/only_static": {
"modified": "2020-10-15T21:25:19.409Z",
"contributors": [
"sideshowbarker",
Expand All @@ -43101,7 +43101,7 @@
"chrisdavidmills"
]
},
"Web/API/IDBKeyRange/upperBound": {
"Web/API/IDBKeyRange/upperBound_static": {
"modified": "2020-12-02T14:57:46.498Z",
"contributors": [
"inexorabletash",
Expand Down Expand Up @@ -45734,7 +45734,7 @@
"modified": "2020-10-15T22:16:57.805Z",
"contributors": ["wbamberg"]
},
"Web/API/MediaRecorder/isTypeSupported": {
"Web/API/MediaRecorder/isTypeSupported_static": {
"modified": "2020-10-15T21:41:15.239Z",
"contributors": [
"Sheppy",
Expand Down Expand Up @@ -46044,7 +46044,7 @@
"chrisdavidmills"
]
},
"Web/API/MediaSource/isTypeSupported": {
"Web/API/MediaSource/isTypeSupported_static": {
"modified": "2020-10-15T21:39:05.440Z",
"contributors": [
"sideshowbarker",
Expand Down Expand Up @@ -47237,11 +47237,11 @@
"samoxbal"
]
},
"Web/API/MouseEvent/WEBKIT_FORCE_AT_FORCE_MOUSE_DOWN": {
"Web/API/MouseEvent/WEBKIT_FORCE_AT_FORCE_MOUSE_DOWN_static": {
"modified": "2019-03-23T22:41:50.576Z",
"contributors": ["Sheppy", "rolfedh", "cvrebert"]
},
"Web/API/MouseEvent/WEBKIT_FORCE_AT_MOUSE_DOWN": {
"Web/API/MouseEvent/WEBKIT_FORCE_AT_MOUSE_DOWN_static": {
"modified": "2019-03-23T22:41:53.422Z",
"contributors": ["Sheppy", "rolfedh", "cvrebert"]
},
Expand Down Expand Up @@ -50370,11 +50370,11 @@
"Jeremie"
]
},
"Web/API/Notification/maxActions": {
"Web/API/Notification/maxActions_static": {
"modified": "2020-10-15T22:22:54.514Z",
"contributors": ["mfuji09", "chrisdavidmills", "MaxMaeder", "bershanskiy"]
},
"Web/API/Notification/permission": {
"Web/API/Notification/permission_static": {
"modified": "2020-10-15T21:24:23.294Z",
"contributors": [
"mfuji09",
Expand All @@ -50401,7 +50401,7 @@
"Sebastianz"
]
},
"Web/API/Notification/requestPermission": {
"Web/API/Notification/requestPermission_static": {
"modified": "2020-10-15T21:24:24.058Z",
"contributors": [
"mfuji09",
Expand Down Expand Up @@ -53667,7 +53667,7 @@
"modified": "2020-10-15T22:16:01.323Z",
"contributors": ["SphinxKnight"]
},
"Web/API/PublicKeyCredential/isUserVerifyingPlatformAuthenticatorAvailable": {
"Web/API/PublicKeyCredential/isUserVerifyingPlatformAuthenticatorAvailable_static": {
"modified": "2020-10-15T22:15:47.370Z",
"contributors": ["EvanGrim", "SphinxKnight"]
},
Expand Down Expand Up @@ -54848,7 +54848,7 @@
"modified": "2020-10-15T21:28:53.665Z",
"contributors": ["Sheppy", "teoli"]
},
"Web/API/RTCPeerConnection/generateCertificate": {
"Web/API/RTCPeerConnection/generateCertificate_static": {
"modified": "2020-10-15T21:42:29.046Z",
"contributors": [
"Sheppy",
Expand Down Expand Up @@ -55168,7 +55168,7 @@
"modified": "2020-10-15T21:55:37.122Z",
"contributors": ["Sheppy", "krosylight", "fscholz", "jpmedley"]
},
"Web/API/RTCRtpReceiver/getCapabilities": {
"Web/API/RTCRtpReceiver/getCapabilities_static": {
"modified": "2020-10-15T22:33:11.036Z",
"contributors": ["Sheppy"]
},
Expand Down Expand Up @@ -55204,7 +55204,7 @@
"modified": "2020-10-15T21:51:50.514Z",
"contributors": ["fscholz", "Sheppy"]
},
"Web/API/RTCRtpSender/getCapabilities": {
"Web/API/RTCRtpSender/getCapabilities_static": {
"modified": "2020-10-15T22:33:15.298Z",
"contributors": ["Sheppy"]
},
Expand Down Expand Up @@ -56578,7 +56578,7 @@
"kscarfone"
]
},
"Web/API/Response/error": {
"Web/API/Response/error_static": {
"modified": "2020-10-15T21:33:30.637Z",
"contributors": [
"mfluehr",
Expand Down Expand Up @@ -56642,7 +56642,7 @@
"kscarfone"
]
},
"Web/API/Response/redirect": {
"Web/API/Response/redirect_static": {
"modified": "2020-10-15T21:33:32.538Z",
"contributors": [
"mfluehr",
Expand Down Expand Up @@ -62302,7 +62302,7 @@
"vishu_gawli"
]
},
"Web/API/URL/createObjectURL": {
"Web/API/URL/createObjectURL_static": {
"modified": "2020-10-15T21:04:18.309Z",
"contributors": [
"alattalatta",
Expand Down Expand Up @@ -62390,7 +62390,7 @@
"modified": "2020-10-15T21:33:36.960Z",
"contributors": ["alattalatta", "chrisdavidmills", "teoli"]
},
"Web/API/URL/revokeObjectURL": {
"Web/API/URL/revokeObjectURL_static": {
"modified": "2020-10-15T21:11:16.158Z",
"contributors": [
"alattalatta",
Expand Down Expand Up @@ -71189,7 +71189,7 @@
"modified": "2020-10-15T22:25:31.153Z",
"contributors": ["Sheppy"]
},
"Web/API/XRWebGLLayer/getNativeFramebufferScaleFactor": {
"Web/API/XRWebGLLayer/getNativeFramebufferScaleFactor_static": {
"modified": "2020-10-15T22:25:35.150Z",
"contributors": ["Sheppy"]
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,14 @@ browser-compat: path.to.feature.NameOfTheMethod
> Format as _NameOfTheParentInterface_**.**_NameOfTheMethod_**()**.
> For example, the [count()](/en-US/docs/Web/API/IDBIndex/count) method of the [IDBIndex](/en-US/docs/Web/API/IDBIndex) interface has a _title_ of `IDBIndex.count()`.
> - **slug**
> - : The end of the URL path after `https://developer.mozilla.org/en-US/docs/`).
>
> - : The end of the URL path after `https://developer.mozilla.org/en-US/docs/`.
> This will be formatted like `Web/API/NameOfTheParentInterface/NameOfTheMethod`.
>
> If the method is static, then the slug must have a `_static` suffix, like: `Web/API/NameOfTheParentInterface/NameOfTheMethod_static`. This enables us to support instance and static methods which have the same name.
>
> Note that the name of the method in the slug omits the parenthesis (it ends in `NameOfTheMethod` not `NameOfTheMethod()`).
>
> - **page-type**
> - : The `page-type` key for Web/API methods is either `web-api-instance-method` (for instance methods) or `web-api-static-method` (for static methods).
> - **status**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,12 @@ browser-compat: path.to.feature.NameOfTheProperty
> Format as _NameOfTheParentInterface_**.**_NameOfTheProperty_.
> For example, the [`capabilities`](/en-US/docs/Web/API/VRDisplay/capabilities) property of the [`VRDisplay`](/en-US/docs/Web/API/VRDisplay) interface has a `title` of `VRDisplay.capabilities`.
> - **slug**
> - : The end of the URL path after `https://developer.mozilla.org/en-US/docs/`).
>
> - : The end of the URL path after `https://developer.mozilla.org/en-US/docs/`.
> This will be formatted like `Web/API/NameOfTheParentInterface/NameOfTheProperty`.
>
> If the property is static, then the slug must have a `_static` suffix, like: `Web/API/NameOfTheParentInterface/NameOfTheProperty_static`. This enables us to support instance and static properties which have the same name.
>
> - **page-type**
> - : The `page-type` key for Web/API properties is either `web-api-instance-property` (for instance properties) or `web-api-static-property` (for static properties).
> - **status**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: declarativeNetRequest.getAvailableStaticRuleCount
slug: Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/getAvailableStaticRuleCount
slug: >-
Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/getAvailableStaticRuleCount
page-type: webextension-api-function
browser-compat: webextensions.api.declarativeNetRequest.getAvailableStaticRuleCount
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: declarativeNetRequest.GETMATCHEDRULES_QUOTA_INTERVAL
slug: Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/GETMATCHEDRULES_QUOTA_INTERVAL
slug: >-
Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/GETMATCHEDRULES_QUOTA_INTERVAL
page-type: webextension-api-property
browser-compat: webextensions.api.declarativeNetRequest.GETMATCHEDRULES_QUOTA_INTERVAL
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: declarativeNetRequest.GUARANTEED_MINIMUM_STATIC_RULES
slug: Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/GUARANTEED_MINIMUM_STATIC_RULES
slug: >-
Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/GUARANTEED_MINIMUM_STATIC_RULES
page-type: webextension-api-property
browser-compat: webextensions.api.declarativeNetRequest.GUARANTEED_MINIMUM_STATIC_RULES
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: declarativeNetRequest.MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL
slug: Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL
slug: >-
Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL
page-type: webextension-api-property
browser-compat: webextensions.api.declarativeNetRequest.MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: declarativeNetRequest.MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES
slug: Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES
slug: >-
Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES
page-type: webextension-api-property
browser-compat: webextensions.api.declarativeNetRequest.MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES
browser-compat: >-
webextensions.api.declarativeNetRequest.MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES
---

{{AddonSidebar()}}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: declarativeNetRequest.MAX_NUMBER_OF_ENABLED_STATIC_RULESETS
slug: Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/MAX_NUMBER_OF_ENABLED_STATIC_RULESETS
slug: >-
Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/MAX_NUMBER_OF_ENABLED_STATIC_RULESETS
page-type: webextension-api-property
browser-compat: webextensions.api.declarativeNetRequest.MAX_NUMBER_OF_ENABLED_STATIC_RULESETS
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: declarativeNetRequest.MAX_NUMBER_OF_REGEX_RULES
slug: Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/MAX_NUMBER_OF_REGEX_RULES
slug: >-
Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/MAX_NUMBER_OF_REGEX_RULES
page-type: webextension-api-property
browser-compat: webextensions.api.declarativeNetRequest.MAX_NUMBER_OF_REGEX_RULES
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: declarativeNetRequest.MAX_NUMBER_OF_STATIC_RULESETS
slug: Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/MAX_NUMBER_OF_STATIC_RULESETS
slug: >-
Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/MAX_NUMBER_OF_STATIC_RULESETS
page-type: webextension-api-property
browser-compat: webextensions.api.declarativeNetRequest.MAX_NUMBER_OF_STATIC_RULESETS
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: declarativeNetRequest.setExtensionActionOptions
slug: Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/setExtensionActionOptions
slug: >-
Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/setExtensionActionOptions
page-type: webextension-api-function
browser-compat: webextensions.api.declarativeNetRequest.setExtensionActionOptions
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "AbortSignal: abort() static method"
short-title: abort()
slug: Web/API/AbortSignal/abort
slug: Web/API/AbortSignal/abort_static
page-type: web-api-static-method
browser-compat: api.AbortSignal.abort
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "AbortSignal: timeout() static method"
short-title: timeout()
slug: Web/API/AbortSignal/timeout
slug: Web/API/AbortSignal/timeout_static
page-type: web-api-static-method
browser-compat: api.AbortSignal.timeout
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "AudioDecoder: isConfigSupported() static method"
short-title: isConfigSupported()
slug: Web/API/AudioDecoder/isConfigSupported
slug: Web/API/AudioDecoder/isConfigSupported_static
page-type: web-api-static-method
status:
- experimental
Expand Down
Loading

0 comments on commit f29d8a6

Please sign in to comment.