fix(docs): Fix macro-related flaws in the template files #28066
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
bsmth
reviewed
Jul 20, 2023
.../mdn/writing_guidelines/page_structures/page_types/api_constructor_subpage_template/index.md
Outdated
Show resolved
Hide resolved
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.
Description
The
{{Specifications}},{{Compat}},{{domxref()}}, and{{svginfo}}macros in template pages are calling on pages that do not exist because the page names are variables being used as examples. These are leading to macro flaws (for example, Specifications and Browser compatibility sections in the API constructor subpage template).This PR edits the macro calls to escape the macro string and also adds text to say how to use the macro when editing the markdown file while authoring.
This PR also makes a few minor edits on template pages.
Motivation
Fix macro flaws