Skip to content

Commit

Permalink
Amend no-code-in-heading rule as there is no clear consensus (mdn#22472)
Browse files Browse the repository at this point in the history
  • Loading branch information
SphinxKnight authored and hamishwillee committed Dec 9, 2022
1 parent f308250 commit 0a66d9c
Showing 1 changed file with 1 addition and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -433,9 +433,7 @@ Keep the following dos and don'ts in mind while creating headings for subsection

- **Don't create single subsections.** Don't subdivide a topic into a single subtopic.
It's either two subheadings or more or none at all.
- **Don't use styles, classes, or macros within headings.** This includes the {{HTMLElement("code")}} element for code terms.
So don't format the heading as "Using the `SuperAmazingThing` interface".
It should instead just be "Using the SuperAmazingThing interface".
- **Don't use inline styles, classes, or macros within headings.** However, you can use backticks to indicate code terms (e.g. "Using `FooBar` interface").
- **Don't create "bumping heads".** These are headings followed immediately by a subheading, with no content text in between them.
This doesn't look good and leaves readers without any explanatory text at the beginning of the outer section.

Expand Down

0 comments on commit 0a66d9c

Please sign in to comment.