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

Add doc aliases #824

Closed
GuillaumeGomez opened this issue Aug 5, 2019 · 6 comments
Closed

Add doc aliases #824

GuillaumeGomez opened this issue Aug 5, 2019 · 6 comments

Comments

@GuillaumeGomez
Copy link
Member

Some objects have to get their crate's name prepended so they don't get confused with the type from another crate (like GtkApplication for example). Maybe adding a #[doc(alias = "Application")] for these types would help the search in the docs?

@EPashkin
Copy link
Member

EPashkin commented Aug 5, 2019

IMHO this is good idea

@GuillaumeGomez
Copy link
Member Author

We could add a new key with doc_alias = "Something". However, I didn't stabilize the doc alias feature in rustdoc yet (the PR is open though: rust-lang/rust#63236).

@sdroege
Copy link
Member

sdroege commented Jan 30, 2021

@GuillaumeGomez This is fixed or not?

@GuillaumeGomez
Copy link
Member Author

Oh right, #[doc(alias = "...")] is stable now. I should do that. :)

@sdroege
Copy link
Member

sdroege commented Feb 6, 2021

@GuillaumeGomez That's #1014 or not?

@GuillaumeGomez
Copy link
Member Author

No, not exactly. Here it's about adding the possibility to have an alias over a type. For example, we renamed gtk::Application to gtk::GtkApplication.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants