Tracking issue for #[doc(alias = "...")]

[GuillaumeGomez]

Edit: Implemented in #49757. From the docs:

This feature allows you to add alias(es) to an item when using the rustdoc search through the doc(alias) attribute. Example:

#![feature(doc_alias)]
#[doc(alias = "x")]
#[doc(alias = "big")]
pub struct BigX;

Then, when looking for it through the rustdoc search, if you enter "x" or "big", search will show the BigX struct first.

[frewsxcv]

which pull request was this implemented in?

[GuillaumeGomez]

woups...

[GuillaumeGomez]

Since it's been implemented a while ago, I'm closing it.

[petrochenkov]

The feature is still unstable and this is the tracking issue, so the compiler points here.
Reopening.

[sgrif]

I tried using this feature today, it doesn't appear to actually be implemented. I tried adding #[doc(alias = "...")] to multiple items, none of them showed up when searching for the alias, nor did they get added to search-index.js (where I assume they were supposed to live)

[sgrif]

Hm, it does appear to work for structs at least -- but not all items that otherwise appear in search. In particular it doesn't work on trait functions

[GuillaumeGomez]

Ah? Interesting. I'll need to take a look at what's generated.

[GuillaumeGomez]

As suggested here, I propose to stabilize this feature in order to make it usable outside of the std docs because of a few cases:

• crates with proc-macro can have their own syntax and might want to document it
• "overload" some items naming (for example in gtk-rs, since one of its dependencies has a Window type, we had to rename it GtkWindow but it'd make sense to have it with better ranking when looking for Window in the docs).

As for now, I don't see anything that could be an obstacle to stabilizing this feature?

@rfcbot fcp merge

[rfcbot]

Team member @GuillaumeGomez has proposed to merge this. The next step is review by the rest of the tagged team members:

• @GuillaumeGomez
• @QuietMisdreavus
• @kinnison
• @ollie27
• @onur

Concerns:

• associated-items resolved by Tracking issue for #[doc(alias = "...")] #50146 (comment)
• invalid-forms resolved by Tracking issue for #[doc(alias = "...")] #50146 (comment)
• naming resolved by Tracking issue for #[doc(alias = "...")] #50146 (comment)
• use-cases resolved by Tracking issue for #[doc(alias = "...")] #50146 (comment)

Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for info about what commands tagged team members can give me.