Skip to content

Commit b32db9a

Browse files
authored
[SYCL][Doc] Update spec template overview (#12339)
Add some suggestions about identifying the target audience for an extension in the Overview section.
1 parent 231a862 commit b32db9a

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

sycl/doc/extensions/template.asciidoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,21 @@ no need to exhaustively show all aspects of your extension. Those details
131131
should be explained in the sections that follow. This section is just an
132132
overview to introduce your readers to your extension._
133133

134+
_It is also appropriate to give an indication of who the target audience is for
135+
the extension. For example, if the extension is intended only for ninja
136+
programmers, we might say something like:_
137+
138+
> The properties described in this extension are advanced features that most
139+
> applications should not need to use. In most cases, applications get the
140+
> best performance without using these properties.
141+
142+
_Occasionally, we might add an extension as a stopgap measure for a limited
143+
audience. When this happens, it's best to discourage general usage with a
144+
statement like:_
145+
146+
> This extension exists to solve a specific problem, and a general solution is
147+
> still being evaluated. It is not recommended for general usage.
148+
134149
_Note that text should be wrapped at 80 columns as shown in this template.
135150
Extensions use AsciiDoc markup language (like this template). If you need help
136151
with AsciiDoc syntax, see

0 commit comments

Comments
 (0)