Skip to content

Commit a12b3e4

Browse files
authored
Merge pull request #500 from dfitzmau/module-lead-in-sentence-472
module-lead-in-sentence-472
2 parents 6de2e49 + 46568e1 commit a12b3e4

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

Diff for: supplementary_style_guide/style_guidelines/structure.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,11 @@ Not a complete sentence: This prerequisite is acceptable if all the other prereq
8080

8181
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_.
8282

83+
[IMPORTANT]
84+
====
85+
Do not start a module with an admonition, even when adding the Technology Preview admonition. Always include a short description before including an admonition.
86+
====
87+
8388
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.
8489

8590
Follow these guidelines when writing short descriptions:

0 commit comments

Comments
 (0)