Skip to content

Commit dcc401b

Browse files
gsnedderssideshowbarker
authored andcommitted
Fix file-names.md to render correctly
1 parent 82d83b1 commit dcc401b

File tree

1 file changed

+35
-27
lines changed

1 file changed

+35
-27
lines changed

docs/_writing-tests/file-names.md

Lines changed: 35 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -8,43 +8,51 @@ The test filename is significant in determining the type of test it
88
contains, and enabling specific optional features. This page documents
99
the various flags avaiable and their meaning.
1010

11+
1112
### Test Type
1213

1314
These flags must be the last element in the filename before the
1415
extension e.g. `foo-manual.html` will indicate a manual test, but
1516
`foo-manual-other.html` will not. Unlike test features, test types
1617
are mutually exclusive.
1718

18-
<dl>
19-
<dt>`-manual`
20-
<dd><p>Indicates that a test is a non-automated test.
21-
<dt>`-support`
22-
<dd><p>Indicates that a file is not a test but a support file.
23-
Not required for files in a directory called `resources`,
24-
`tools` or `support`.
25-
<dt>`-visual`
26-
<dd><p>Indicates that a file is a visual test.
27-
</dl>
19+
20+
`-manual`
21+
: Indicates that a test is a non-automated test.
22+
23+
`-support`
24+
: Indicates that a file is not a test but a support file. Not
25+
required for files in a directory called `resources`, `tools` or
26+
`support`.
27+
28+
`-visual`
29+
: Indicates that a file is a visual test.
30+
2831

2932
### Test Features
3033

3134
These flags are preceded by a `.` in the filename, and must
3235
themselves precede any test type flag, but are otherwise unordered.
3336

34-
<dl>
35-
<dt>`.https`
36-
<dd><p>Indicates that a test is loaded over HTTPS.
37-
<dt>`.sub`
38-
<dd><p>Indicates that a test uses the
39-
<a href="https://wptserve.readthedocs.io/en/latest/pipes.html#sub">
40-
server-side substitution</a> feature.
41-
<dt>`.window`
42-
<dd><p>(js files only) Indicates that the file generates a test in
43-
which it is run in a Window environment.
44-
<dt>`.worker`
45-
<dd><p>(js files only) Indicates that the file generates a test in
46-
which it is run in a dedicated worker environment.
47-
<dt>`.any`
48-
<dd><p>(js files only) Indicates that the file generates tests in
49-
which it is run in Window and dedicated worker environments.
50-
</dl>
37+
38+
`.https`
39+
: Indicates that a test is loaded over HTTPS.
40+
41+
`.sub`
42+
: Indicates that a test uses the [server-side substitution][]
43+
feature.
44+
45+
`.window`
46+
: (js files only) Indicates that the file generates a test in which
47+
it is run in a Window environment.
48+
49+
`.worker`
50+
: (js files only) Indicates that the file generates a test in which
51+
it is run in a dedicated worker environment.
52+
53+
`.any`
54+
: (js files only) Indicates that the file generates tests in which it
55+
is run in Window and dedicated worker environments.
56+
57+
58+
[server-side substitution]: https://wptserve.readthedocs.io/en/latest/pipes.html#sub

0 commit comments

Comments
 (0)