fix: Render userScripts_legacy.register as userScripts.register (Legacy) #12677
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.
Summary
Render
userScripts_legacy.register
asuserScripts.register (legacy)
in the example overview at https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/ExamplesSee mdn/webextensions-examples#579
Problem
There are two versions of the
userScripts.register
API. In the API sidebar, documentation, BCD, etc., they are distinguished by the "(Legacy)" suffix. The documentation is at:The current macro assumes that the URL slug and API name are identical. This is not the case for
userScripts.register
, so theexamples.json
index usesuserScripts_legacy.register
to refer to the legacy API. However, that causes the example to be rendered as "userScripts_legacy.register", which is not the name of the API.Solution
The patch fixes the issue by special-casing this one exception, and rendering the anchor label as
userScripts.register (Legacy)
.