Skip to content

Commit d3a4cd6

Browse files
committed
rustdoc: add note about slice/array searches to help popup
1 parent 7a1154e commit d3a4cd6

File tree

4 files changed

+22
-22
lines changed

4 files changed

+22
-22
lines changed

src/librustdoc/html/static/js/main.js

+4
Original file line numberDiff line numberDiff line change
@@ -1077,6 +1077,10 @@ function preLoadCss(cssUrl) {
10771077
<code>-&gt; vec</code> or <code>String, enum:Cow -&gt; bool</code>)",
10781078
"You can look for items with an exact name by putting double quotes around \
10791079
your request: <code>\"string\"</code>",
1080+
"Look for functions that accept or return \
1081+
<a href=\"https://doc.rust-lang.org/std/primitive.slice.html\">slices</a> and \
1082+
<a href=\"https://doc.rust-lang.org/std/primitive.array.html\">arrays</a> by writing \
1083+
square brackets (e.g., <code>-&gt; [u8]</code> or <code>[] -&gt; Option</code>)",
10801084
"Look for items inside another one by searching for a path: <code>vec::Vec</code>",
10811085
].map(x => "<p>" + x + "</p>").join("");
10821086
const div_infos = document.createElement("div");

tests/rustdoc-js-std/osstring-to-string.js

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
// exact-match
22

33
// https://github.com/rust-lang/rust/issues/60485#issuecomment-663900624
4-
const QUERY = 'OsString -> String';
5-
64
const EXPECTED = {
5+
'query': 'OsString -> String',
76
'others': [
87
{ 'path': 'std::ffi::OsString', 'name': 'into_string' },
98
]

tests/rustdoc-js-std/parser-slice-array.js

+16-19
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,6 @@
1-
const QUERY = [
2-
'[[[D, []]]',
3-
'[[[D, []]]]',
4-
'[] u8',
5-
'[u8]',
6-
'[u8,u8]',
7-
'[u8<u8>]',
8-
'[]',
9-
'[>',
10-
'[<',
11-
'[a>',
12-
'[a<',
13-
'[a',
14-
'[',
15-
']',
16-
'primitive:[u8]',
17-
'macro:[u8]',
18-
];
19-
201
const PARSED = [
212
{
3+
query: '[[[D, []]]',
224
elems: [],
235
foundElems: 0,
246
original: '[[[D, []]]',
@@ -27,6 +9,7 @@ const PARSED = [
279
error: 'Unclosed `[`',
2810
},
2911
{
12+
query: '[[[D, []]]]',
3013
elems: [
3114
{
3215
name: "[]",
@@ -79,6 +62,7 @@ const PARSED = [
7962
error: null,
8063
},
8164
{
65+
query: '[] u8',
8266
elems: [
8367
{
8468
name: "[]",
@@ -104,6 +88,7 @@ const PARSED = [
10488
error: null,
10589
},
10690
{
91+
query: '[u8]',
10792
elems: [
10893
{
10994
name: "[]",
@@ -130,6 +115,7 @@ const PARSED = [
130115
error: null,
131116
},
132117
{
118+
query: '[u8,u8]',
133119
elems: [
134120
{
135121
name: "[]",
@@ -164,6 +150,7 @@ const PARSED = [
164150
error: null,
165151
},
166152
{
153+
query: '[u8<u8>]',
167154
elems: [
168155
{
169156
name: "[]",
@@ -199,6 +186,7 @@ const PARSED = [
199186
error: null,
200187
},
201188
{
189+
query: '[]',
202190
elems: [
203191
{
204192
name: "[]",
@@ -216,6 +204,7 @@ const PARSED = [
216204
error: null,
217205
},
218206
{
207+
query: '[>',
219208
elems: [],
220209
foundElems: 0,
221210
original: "[>",
@@ -224,6 +213,7 @@ const PARSED = [
224213
error: "Unexpected `>` after `[`",
225214
},
226215
{
216+
query: '[<',
227217
elems: [],
228218
foundElems: 0,
229219
original: "[<",
@@ -232,6 +222,7 @@ const PARSED = [
232222
error: "Found generics without a path",
233223
},
234224
{
225+
query: '[a>',
235226
elems: [],
236227
foundElems: 0,
237228
original: "[a>",
@@ -240,6 +231,7 @@ const PARSED = [
240231
error: "Unexpected `>` after `[`",
241232
},
242233
{
234+
query: '[a<',
243235
elems: [],
244236
foundElems: 0,
245237
original: "[a<",
@@ -248,6 +240,7 @@ const PARSED = [
248240
error: "Unclosed `<`",
249241
},
250242
{
243+
query: '[a',
251244
elems: [],
252245
foundElems: 0,
253246
original: "[a",
@@ -256,6 +249,7 @@ const PARSED = [
256249
error: "Unclosed `[`",
257250
},
258251
{
252+
query: '[',
259253
elems: [],
260254
foundElems: 0,
261255
original: "[",
@@ -264,6 +258,7 @@ const PARSED = [
264258
error: "Unclosed `[`",
265259
},
266260
{
261+
query: ']',
267262
elems: [],
268263
foundElems: 0,
269264
original: "]",
@@ -272,6 +267,7 @@ const PARSED = [
272267
error: "Unexpected `]`",
273268
},
274269
{
270+
query: 'primitive:[u8]',
275271
elems: [
276272
{
277273
name: "[]",
@@ -298,6 +294,7 @@ const PARSED = [
298294
error: null,
299295
},
300296
{
297+
query: 'macro:[u8]',
301298
elems: [],
302299
foundElems: 0,
303300
original: "macro:[u8]",

tests/rustdoc-js/slice-array.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ const EXPECTED = [
5252
],
5353
},
5454
{
55-
'query': '[TraitDog]',
55+
'query': '[TraitCat]',
5656
'in_args': [
5757
{ 'path': 'slice_array', 'name': 'gamma' },
5858
{ 'path': 'slice_array', 'name': 'epsilon' },

0 commit comments

Comments
 (0)