File tree Expand file tree Collapse file tree 1 file changed +15
-0
lines changed Expand file tree Collapse file tree 1 file changed +15
-0
lines changed 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
131
131
should be explained in the sections that follow. This section is just an
132
132
overview to introduce your readers to your extension._
133
133
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
+
134
149
_Note that text should be wrapped at 80 columns as shown in this template.
135
150
Extensions use AsciiDoc markup language (like this template). If you need help
136
151
with AsciiDoc syntax, see
You can’t perform that action at this time.
0 commit comments