Skip to content

Commit

Permalink
[SYCL][Doc] Update spec template overview (intel#12339)
Browse files Browse the repository at this point in the history
Add some suggestions about identifying the target audience for an
extension in the Overview section.
gmlueck authored Jan 10, 2024
1 parent 231a862 commit b32db9a
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions sycl/doc/extensions/template.asciidoc
Original file line number Diff line number Diff line change
@@ -131,6 +131,21 @@ no need to exhaustively show all aspects of your extension. Those details
should be explained in the sections that follow. This section is just an
overview to introduce your readers to your extension._

_It is also appropriate to give an indication of who the target audience is for
the extension. For example, if the extension is intended only for ninja
programmers, we might say something like:_

> The properties described in this extension are advanced features that most
> applications should not need to use. In most cases, applications get the
> best performance without using these properties.

_Occasionally, we might add an extension as a stopgap measure for a limited
audience. When this happens, it's best to discourage general usage with a
statement like:_

> This extension exists to solve a specific problem, and a general solution is
> still being evaluated. It is not recommended for general usage.

_Note that text should be wrapped at 80 columns as shown in this template.
Extensions use AsciiDoc markup language (like this template). If you need help
with AsciiDoc syntax, see

0 comments on commit b32db9a

Please sign in to comment.