fork/rust

git clone https://git.julia.blue/fork/rust

borsAuto merge of #103046 - JanBeh:PR_clarify_cmp_terminology, r=workingjubilee3bcad65fbf6

master
10.6 KiB234 linesraw
1// This test checks that headers (a) have the correct heading level, (b) are the right size,
2// and (c) have the correct underlining (or absence of underlining).
3// The sizes may change as design changes, but try to make sure a lower header is never bigger than
4// its parent headers. Also make sure lower headers don't have underlines when their parents lack
5// an underline.
6// Most of these sizes are set in CSS in `em` units, so here's a conversion chart based on our
7// default 16px font size:
8// 24px    1.5em
9// 22px  1.375rem
10// 20px  1.25rem
11// 18px  1.125em
12// 16px  1rem
13// 14px  0.875rem
14go-to: "file://" + |DOC_PATH| + "/test_docs/struct.HeavilyDocumentedStruct.html"
15
16assert-css: (".main-heading h1", {"font-size": "24px"})
17
18assert-css: ("h2#top-doc-prose-title", {"font-size": "22px"})
19assert-css: ("h2#top-doc-prose-title", {"border-bottom-width": "1px"})
20assert-css: ("h3#top-doc-prose-sub-heading", {"font-size": "20px"})
21assert-css: ("h3#top-doc-prose-sub-heading", {"border-bottom-width": "1px"})
22assert-css: ("h4#top-doc-prose-sub-sub-heading", {"font-size": "18px"})
23assert-css: ("h4#top-doc-prose-sub-sub-heading", {"border-bottom-width": "1px"})
24
25assert-css: ("h2#fields", {"font-size": "22px"})
26assert-css: ("h2#fields", {"border-bottom-width": "1px"})
27assert-css: ("h3#title-for-field", {"font-size": "20px"})
28assert-css: ("h3#title-for-field", {"border-bottom-width": "0px"})
29assert-css: ("h4#sub-heading-for-field", {"font-size": "16px"})
30assert-css: ("h4#sub-heading-for-field", {"border-bottom-width": "0px"})
31
32assert-css: ("h2#implementations", {"font-size": "22px"})
33assert-css: ("h2#implementations", {"border-bottom-width": "1px"})
34
35assert-css: ("#impl-HeavilyDocumentedStruct > h3.code-header", {"font-size": "18px"})
36assert-css: ("#impl-HeavilyDocumentedStruct > h3.code-header", {"border-bottom-width": "0px"})
37assert-css: ("#method\.do_nothing > h4.code-header", {"font-size": "16px"})
38assert-css: ("#method\.do_nothing > h4.code-header", {"border-bottom-width": "0px"})
39
40assert-css: ("h4#title-for-struct-impl-doc", {"font-size": "16px"})
41assert-css: ("h4#title-for-struct-impl-doc", {"border-bottom-width": "0px"})
42assert-css: ("h5#sub-heading-for-struct-impl-doc", {"font-size": "16px"})
43assert-css: ("h5#sub-heading-for-struct-impl-doc", {"border-bottom-width": "0px"})
44assert-css: ("h6#sub-sub-heading-for-struct-impl-doc", {"font-size": "14px"})
45assert-css: ("h6#sub-sub-heading-for-struct-impl-doc", {"border-bottom-width": "0px"})
46
47assert-css: ("h5#title-for-struct-impl-item-doc", {"font-size": "16px"})
48assert-css: ("h5#title-for-struct-impl-item-doc", {"border-bottom-width": "0px"})
49assert-css: ("h6#sub-heading-for-struct-impl-item-doc", {"font-size": "14px"})
50assert-css: ("h6#sub-heading-for-struct-impl-item-doc", {"border-bottom-width": "0px"})
51assert-css: ("h6#sub-sub-heading-for-struct-impl-item-doc", {"font-size": "14px"})
52
53go-to: "file://" + |DOC_PATH| + "/test_docs/enum.HeavilyDocumentedEnum.html"
54
55assert-css: (".main-heading h1", {"font-size": "24px"})
56
57assert-css: ("h2#top-doc-prose-title", {"font-size": "22px"})
58assert-css: ("h2#top-doc-prose-title", {"border-bottom-width": "1px"})
59assert-css: ("h3#top-doc-prose-sub-heading", {"font-size": "20px"})
60assert-css: ("h3#top-doc-prose-sub-heading", {"border-bottom-width": "1px"})
61assert-css: ("h4#top-doc-prose-sub-sub-heading", {"font-size": "18px"})
62assert-css: ("h4#top-doc-prose-sub-sub-heading", {"border-bottom-width": "1px"})
63
64assert-css: ("h2#variants", {"font-size": "22px"})
65assert-css: ("h2#variants", {"border-bottom-width": "1px"})
66
67assert-css: ("h4#none-prose-title", {"font-size": "16px"})
68assert-css: ("h4#none-prose-title", {"border-bottom-width": "0px"})
69assert-css: ("h5#none-prose-sub-heading", {"font-size": "16px"})
70assert-css: ("h5#none-prose-sub-heading", {"border-bottom-width": "0px"})
71
72assert-css: ("h4#wrapped-prose-title", {"font-size": "16px"})
73assert-css: ("h4#wrapped-prose-title", {"border-bottom-width": "0px"})
74assert-css: ("h5#wrapped-prose-sub-heading", {"font-size": "16px"})
75assert-css: ("h5#wrapped-prose-sub-heading", {"border-bottom-width": "0px"})
76
77assert-css: ("h5#wrapped0-prose-title", {"font-size": "16px"})
78assert-css: ("h5#wrapped0-prose-title", {"border-bottom-width": "0px"})
79assert-css: ("h6#wrapped0-prose-sub-heading", {"font-size": "14px"})
80assert-css: ("h6#wrapped0-prose-sub-heading", {"border-bottom-width": "0px"})
81
82assert-css: ("h5#structy-prose-title", {"font-size": "16px"})
83assert-css: ("h5#structy-prose-title", {"border-bottom-width": "0px"})
84assert-css: ("h6#structy-prose-sub-heading", {"font-size": "14px"})
85assert-css: ("h6#structy-prose-sub-heading", {"border-bottom-width": "0px"})
86
87assert-css: ("h2#implementations", {"font-size": "22px"})
88assert-css: ("h2#implementations", {"border-bottom-width": "1px"})
89
90assert-css: ("#impl-HeavilyDocumentedEnum > h3.code-header", {"font-size": "18px"})
91assert-css: ("#impl-HeavilyDocumentedEnum > h3.code-header", {"border-bottom-width": "0px"})
92assert-css: ("#method\.do_nothing > h4.code-header", {"font-size": "16px"})
93assert-css: ("#method\.do_nothing > h4.code-header", {"border-bottom-width": "0px"})
94
95assert-css: ("h4#title-for-enum-impl-doc", {"font-size": "16px"})
96assert-css: ("h4#title-for-enum-impl-doc", {"border-bottom-width": "0px"})
97assert-css: ("h5#sub-heading-for-enum-impl-doc", {"font-size": "16px"})
98assert-css: ("h5#sub-heading-for-enum-impl-doc", {"border-bottom-width": "0px"})
99assert-css: ("h6#sub-sub-heading-for-enum-impl-doc", {"font-size": "14px"})
100assert-css: ("h6#sub-sub-heading-for-enum-impl-doc", {"border-bottom-width": "0px"})
101
102assert-css: ("h5#title-for-enum-impl-item-doc", {"font-size": "16px"})
103assert-css: ("h5#title-for-enum-impl-item-doc", {"border-bottom-width": "0px"})
104assert-css: ("h6#sub-heading-for-enum-impl-item-doc", {"font-size": "14px"})
105assert-css: ("h6#sub-heading-for-enum-impl-item-doc", {"border-bottom-width": "0px"})
106assert-css: ("h6#sub-sub-heading-for-enum-impl-item-doc", {"font-size": "14px"})
107assert-css: ("h6#sub-sub-heading-for-enum-impl-item-doc", {"border-bottom-width": "0px"})
108
109assert-text: ("//ul[@class='block mod']/preceding-sibling::h3", "Modules")
110assert-css: ("//ul[@class='block mod']/preceding-sibling::h3", {"border-bottom-width": "0px"}, ALL)
111
112go-to: "file://" + |DOC_PATH| + "/test_docs/union.HeavilyDocumentedUnion.html"
113
114assert-css: (".main-heading h1", {"font-size": "24px"})
115
116assert-css: ("h2#top-doc-prose-title", {"font-size": "22px"})
117assert-css: ("h2#top-doc-prose-title", {"border-bottom-width": "1px"})
118assert-css: ("h3#top-doc-prose-sub-heading", {"font-size": "20px"})
119assert-css: ("h3#top-doc-prose-sub-heading", {"border-bottom-width": "1px"})
120
121assert-css: ("h2#fields", {"font-size": "22px"})
122assert-css: ("h2#fields", {"border-bottom-width": "1px"})
123
124assert-css: ("h3#title-for-union-variant", {"font-size": "20px"})
125assert-css: ("h3#title-for-union-variant", {"border-bottom-width": "0px"})
126assert-css: ("h4#sub-heading-for-union-variant", {"font-size": "16px"})
127assert-css: ("h4#sub-heading-for-union-variant", {"border-bottom-width": "0px"})
128
129assert-css: ("h2#implementations", {"font-size": "22px"})
130assert-css: ("h2#implementations", {"border-bottom-width": "1px"})
131
132assert-css: ("#impl-HeavilyDocumentedUnion > h3.code-header", {"font-size": "18px"})
133assert-css: ("#impl-HeavilyDocumentedUnion > h3.code-header", {"border-bottom-width": "0px"})
134assert-css: ("h4#title-for-union-impl-doc", {"font-size": "16px"})
135assert-css: ("h4#title-for-union-impl-doc", {"border-bottom-width": "0px"})
136assert-css: ("h5#sub-heading-for-union-impl-doc", {"font-size": "16px"})
137assert-css: ("h5#sub-heading-for-union-impl-doc", {"border-bottom-width": "0px"})
138
139assert-css: ("h5#title-for-union-impl-item-doc", {"font-size": "16px"})
140assert-css: ("h5#title-for-union-impl-item-doc", {"border-bottom-width": "0px"})
141assert-css: ("h6#sub-heading-for-union-impl-item-doc", {"font-size": "14px"})
142assert-css: ("h6#sub-heading-for-union-impl-item-doc", {"border-bottom-width": "0px"})
143
144go-to: "file://" + |DOC_PATH| + "/test_docs/macro.heavily_documented_macro.html"
145
146assert-css: (".main-heading h1", {"font-size": "24px"})
147
148assert-css: ("h2#top-doc-prose-title", {"font-size": "22px"})
149assert-css: ("h2#top-doc-prose-title", {"border-bottom-width": "1px"})
150assert-css: ("h3#top-doc-prose-sub-heading", {"font-size": "20px"})
151assert-css: ("h3#top-doc-prose-sub-heading", {"border-bottom-width": "1px"})
152
153// Needed to check colors
154show-text: true
155go-to: "file://" + |DOC_PATH| + "/test_docs/struct.HeavilyDocumentedStruct.html"
156
157define-function: (
158    "check-colors",
159    (theme, heading_color, small_heading_color, heading_border_color),
160    block {
161        set-local-storage: {"rustdoc-theme": |theme|, "rustdoc-use-system-theme": "false"}
162        reload:
163        assert-css: (
164            ".top-doc .docblock h2",
165            {"color": |heading_color|, "border-bottom": "1px solid " + |heading_border_color|},
166        )
167        assert-css: (
168            ".top-doc .docblock h3",
169            {"color": |heading_color|, "border-bottom": "1px solid " + |heading_border_color|},
170        )
171        assert-css: (
172            ".top-doc .docblock h4",
173            {"color": |heading_color|, "border-bottom": "1px solid " + |heading_border_color|},
174        )
175        assert-css: (
176            ".top-doc .docblock h5",
177            {"color": |small_heading_color|, "border-bottom-width": "0px"},
178        )
179        assert-css: (
180            "#implementations-list .docblock h4",
181            {"color": |heading_color|, "border-bottom-width": "0px"},
182        )
183        assert-css: (
184            "#implementations-list .docblock h5",
185            {"color": |small_heading_color|, "border-bottom-width": "0px"},
186        )
187        assert-css: (
188            "#implementations-list .docblock h6",
189            {"color": |small_heading_color|, "border-bottom-width": "0px"},
190        )
191    },
192)
193call-function: (
194    "check-colors",
195    {
196        "theme": "ayu",
197        "heading_color": "#fff",
198        "small_heading_color": "#c5c5c5",
199        "heading_border_color": "#5c6773",
200    },
201)
202call-function: (
203    "check-colors",
204    {
205        "theme": "dark",
206        "heading_color": "#ddd",
207        "small_heading_color": "#ddd",
208        "heading_border_color": "#d2d2d2",
209    },
210)
211call-function: (
212    "check-colors",
213    {
214        "theme": "light",
215        "heading_color": "black",
216        "small_heading_color": "black",
217        "heading_border_color": "#ddd",
218    },
219)
220
221define-function: (
222    "check-since-color",
223    (theme),
224    block {
225        set-local-storage: {"rustdoc-theme": |theme|}
226        reload:
227        assert-css: (".since", {"color": "#808080"}, ALL)
228    },
229)
230
231go-to: "file://" + |DOC_PATH| + "/staged_api/struct.Foo.html"
232call-function: ("check-since-color", ("ayu"))
233call-function: ("check-since-color", ("dark"))
234call-function: ("check-since-color", ("light"))