Make html rendered by rustdoc allow searching non-English identifier / alias

[Sunshine40]

Fix alias search result showing undefined description.

Inspired by rust-lang/mdBook#2393 .

Not sure if it's worth it adding full-text search functionality to rustdoc rendered html.

[rustbot]

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @fmease (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

• @rustbot author: the review is finished, PR author should check the comments and take action accordingly
• @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

[rustbot]

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @jsha

[Sunshine40]

Demo:

Corresponding code:

/// 这是一个加法函数
#[doc(alias = "加法")]
pub fn add(left: usize, right: usize) -> usize {
    left + right
}

/// 这等效于 add 函数，但是用中文命名
pub fn 中文名称的加法API(left: usize, right: usize) -> usize {
    left + right
}

#[macro_export]
macro_rules! 中文命名的加法宏 {
    () => {};
}

/// 英文命名的加法宏
#[doc(alias = "加法")]
#[macro_export]
macro_rules! add {
    () => {};
}

[GuillaumeGomez]

Seems like a very good start! Can you add tests in rustdoc-js to ensure we don't break it in the future please?

Also cc @notriddle

[Sunshine40]

Can you add tests in rustdoc-js to ensure we don't break it in the future please?

Done.

[Sunshine40]

I think you'll need to bump the EcmaScript version in the eslint configuration. It's currently set to 8, but if I'm understanding the Introduction correctly, it need bumped to 9.

I'd be happy to do that if dropping support for some legacy browser versions is acceptable (I must admit, I didn't think about browser compatibility at the beginning)

[notriddle]

Here's where the browser support matrix is defined: https://rust-lang.github.io/rfcs/1985-tiered-browser-support.html.

At the present time, clicking the browserList link in the RFC gives out:

• Chrome 124, 125
• Firefox 126, 115
• Safari 17.5

It also lists these two, but MDN doesn't have compat data for UC Browser, and they're both based on Blink so it probably doesn't matter.

• Edge 125
• UC Browser 15.5

According to MDN, Unicode property escapes are available in Chrome 64, Firefox 78, and Safari 11. It should be fine.

[notriddle]

Does anybody know why we have both of these? There's two spots where we're checking es versions.

rust/src/ci/docker/host-x86_64/mingw-check/Dockerfile

Line 65 in 98489f2

es-check es8 ../src/librustdoc/html/static/js/*.js && \

[Sunshine40]

Does anybody know why we have both of these? There's two spots where we're checking es versions.

Because ES-Check and ESLint are separate tools, and there's no out-of-the-box solution to make them share configurations?

[Sunshine40]

Should I bump the EcmaScript version in these files as well?

/src/tools/rustdoc-js/.eslintrc.js
/src/tools/rustdoc-gui/.eslintrc.js

[notriddle]

Probably a smart idea, yes.

[GuillaumeGomez]

Looks good to me, thanks a lot! Just letting @notriddle review to ensure I didn't miss something.

[notriddle]

r? notriddle

@bors r+

This seems like a reasonable choice to me. It does change things so that if you just search for _ it gives a "not a valid identifier" error, while it used to actually search for names with underscores in them.

Not a big deal, since that's not a very useful query. We can fix it if it's actually a problem.

[bors]

📌 Commit ceaa42b has been approved by notriddle

It is now in the queue for this repository.