Skip to content

Commit

Permalink
Merge pull request #500 from dfitzmau/module-lead-in-sentence-472
Browse files Browse the repository at this point in the history
module-lead-in-sentence-472
  • Loading branch information
lahinson authored Jul 17, 2024
2 parents 6de2e49 + 46568e1 commit a12b3e4
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions supplementary_style_guide/style_guidelines/structure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,11 @@ Not a complete sentence: This prerequisite is acceptable if all the other prereq

To help readers find the information that they need or to confirm that they are in the right place, every module and assembly must include a _short description_, also called an _abstract_.

[IMPORTANT]
====
Do not start a module with an admonition, even when adding the Technology Preview admonition. Always include a short description before including an admonition.
====

This description is usually at least 2-3 sentences long, and you can scan it in a few seconds. It exists between the title and the main content, connecting them and providing context and disambiguation.

Follow these guidelines when writing short descriptions:
Expand Down

0 comments on commit a12b3e4

Please sign in to comment.