Skip to content

Commit dbeef45

Browse files
Rollup merge of rust-lang#115490 - pitaj:rustdoc-searchjs-comment, r=GuillaumeGomez
rustdoc: update comment in search.js for rust-lang#107629 Addressing rust-lang#107629 (comment) r? `@jsha`
2 parents 3db7fc1 + b1e32ea commit dbeef45

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

src/librustdoc/html/static/js/search.js

+17-8
Original file line numberDiff line numberDiff line change
@@ -2537,18 +2537,25 @@ ${item.displayPath}<span class="${type}">${name}</span>\
25372537
let crateSize = 0;
25382538

25392539
/**
2540-
* The raw search data for a given crate. `n`, `t`, `d`, and `q`, `i`, and `f`
2541-
* are arrays with the same length. n[i] contains the name of an item.
2542-
* t[i] contains the type of that item (as a string of characters that represent an
2543-
* offset in `itemTypes`). d[i] contains the description of that item.
2540+
* The raw search data for a given crate. `n`, `t`, `d`, `i`, and `f`
2541+
* are arrays with the same length. `q`, `a`, and `c` use a sparse
2542+
* representation for compactness.
25442543
*
2545-
* q[i] contains the full path of the item, or an empty string indicating
2546-
* "same as q[i-1]".
2544+
* `n[i]` contains the name of an item.
25472545
*
2548-
* i[i] contains an item's parent, usually a module. For compactness,
2546+
* `t[i]` contains the type of that item
2547+
* (as a string of characters that represent an offset in `itemTypes`).
2548+
*
2549+
* `d[i]` contains the description of that item.
2550+
*
2551+
* `q` contains the full paths of the items. For compactness, it is a set of
2552+
* (index, path) pairs used to create a map. If a given index `i` is
2553+
* not present, this indicates "same as the last index present".
2554+
*
2555+
* `i[i]` contains an item's parent, usually a module. For compactness,
25492556
* it is a set of indexes into the `p` array.
25502557
*
2551-
* f[i] contains function signatures, or `0` if the item isn't a function.
2558+
* `f[i]` contains function signatures, or `0` if the item isn't a function.
25522559
* Functions are themselves encoded as arrays. The first item is a list of
25532560
* types representing the function's inputs, and the second list item is a list
25542561
* of types representing the function's output. Tuples are flattened.
@@ -2562,6 +2569,8 @@ ${item.displayPath}<span class="${type}">${name}</span>\
25622569
*
25632570
* `p` is a list of path/type pairs. It is used for parents and function parameters.
25642571
*
2572+
* `c` is an array of item indices that are deprecated.
2573+
*
25652574
* @type {{
25662575
* doc: string,
25672576
* a: Object,

0 commit comments

Comments
 (0)