Skip to content

Rank doc aliases lower than equivalently matched items #145100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 9, 2025
+54 −0
Merged

Rank doc aliases lower than equivalently matched items #145100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b39357b
Rank doc aliases lower than equivalently matched items
GuillaumeGomez Aug 8, 2025
a34bd2b
Add regression test for doc alias matching vs equivalently matched items
GuillaumeGomez Aug 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/librustdoc/html/static/js/search.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3340,6 +3340,13 @@ class DocSearch {
return a - b;
}

// sort doc alias items later
a = Number(aaa.item.is_alias === true);
b = Number(bbb.item.is_alias === true);
if (a !== b) {
return a - b;
}

// sort by item name (lexicographically larger goes later)
let aw = aaa.word;
let bw = bbb.word;
Expand Down
38 changes: 38 additions & 0 deletions tests/rustdoc-js/doc-alias-after-other-items.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// exact-check

// Checking that doc aliases are always listed after items with equivalent matching.

const EXPECTED = [
{
'query': 'coo',
'others': [
{
'path': 'doc_alias_after_other_items',
'name': 'Foo',
'href': '../doc_alias_after_other_items/struct.Foo.html',
},
{
'path': 'doc_alias_after_other_items',
'name': 'bar',
'alias': 'Boo',
'is_alias': true
},
],
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test is ineffective, as Bar would lexicographically sort before foo anyways. This could be fixed just by swapping the names, so the struct is Foo and the function is bar.

I ran the test against current master and it passed, which is generally never what you want for tests introduced alongside what they are testing

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, updated the test.

{
'query': '"confiture"',
'others': [
{
'path': 'doc_alias_after_other_items',
'name': 'Confiture',
'href': '../doc_alias_after_other_items/struct.Confiture.html',
},
{
'path': 'doc_alias_after_other_items',
'name': 'this_is_a_long_name',
'alias': 'Confiture',
'is_alias': true
},
],
},
];
9 changes: 9 additions & 0 deletions tests/rustdoc-js/doc-alias-after-other-items.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
pub struct Foo;

#[doc(alias = "Boo")]
pub fn bar() {}

pub struct Confiture;

#[doc(alias = "Confiture")]
pub fn this_is_a_long_name() {}
Loading