Skip to content
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.

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

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

Open
GuillaumeGomez opened this issue Apr 21, 2018 · 9 comments

Comments

@GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Apr 21, 2018

No description provided.

@GuillaumeGomez GuillaumeGomez self-assigned this Apr 21, 2018
@frewsxcv

This comment has been minimized.

Copy link
Member

@frewsxcv frewsxcv commented Apr 23, 2018

which pull request was this implemented in?

@GuillaumeGomez

This comment has been minimized.

Copy link
Member Author

@GuillaumeGomez GuillaumeGomez commented Apr 23, 2018

@GuillaumeGomez

This comment has been minimized.

Copy link
Member Author

@GuillaumeGomez GuillaumeGomez commented Jul 8, 2018

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

@petrochenkov

This comment has been minimized.

Copy link
Contributor

@petrochenkov petrochenkov commented Nov 1, 2018

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

@petrochenkov petrochenkov reopened this Nov 1, 2018
@sgrif

This comment has been minimized.

Copy link
Contributor

@sgrif sgrif commented May 28, 2019

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

This comment has been minimized.

Copy link
Contributor

@sgrif sgrif commented May 28, 2019

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

This comment has been minimized.

Copy link
Member Author

@GuillaumeGomez GuillaumeGomez commented May 29, 2019

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

@GuillaumeGomez

This comment has been minimized.

Copy link
Member Author

@GuillaumeGomez GuillaumeGomez commented Nov 26, 2019

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

This comment has been minimized.

Copy link

@rfcbot rfcbot commented Nov 26, 2019

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

No concerns currently listed.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
7 participants
You can’t perform that action at this time.