about summary refs log tree commit diff
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume1.gomez@gmail.com>2025-07-19 22:29:13 +0200
committerGuillaume Gomez <guillaume1.gomez@gmail.com>2025-07-19 22:29:13 +0200
commit2f14d0a65d7ec8ee35e7f25ddd996ae40615a2a3 (patch)
tree75bfd4463911b9be008e102f37de408f668b01fb
parentc079c96877fdd3977c8d5be830931ecb4f79018d (diff)
downloadrust-2f14d0a65d7ec8ee35e7f25ddd996ae40615a2a3.tar.gz
rust-2f14d0a65d7ec8ee35e7f25ddd996ae40615a2a3.zip
Add code comment explaining better what `Row.name` is for doc aliases
-rw-r--r--src/librustdoc/html/static/js/rustdoc.d.ts2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/librustdoc/html/static/js/rustdoc.d.ts b/src/librustdoc/html/static/js/rustdoc.d.ts
index 9ce24d1c06f..a9589764547 100644
--- a/src/librustdoc/html/static/js/rustdoc.d.ts
+++ b/src/librustdoc/html/static/js/rustdoc.d.ts
@@ -219,6 +219,8 @@ declare namespace rustdoc {
         crate: string,
         descShard: SearchDescShard,
         id: number,
+        // This is the name of the item. For doc aliases, if you want the name of the aliased
+        // item, take a look at `Row.original.name`.
         name: string,
         normalizedName: string,
         word: string,