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

doc: prose mentioning types should include links to that type #34747

Closed
glandium opened this issue Jul 10, 2016 · 4 comments
Closed

doc: prose mentioning types should include links to that type #34747

glandium opened this issue Jul 10, 2016 · 4 comments

Comments

@glandium
Copy link
Contributor

See for example https://doc.rust-lang.org/std/macro.vec!.html

There are many mentions of Vec, like in

Creates a Vec containing the arguments.

and it would really be useful if that linked to the corresponding type.

@steveklabnik
Copy link
Member

This is generally true, however, this ticket isn't particularly actionable, since there's no good way to tell if we've got them all or not. As such, I'm going to give it a close, but yes, any PRs to improve linking here is a good thing!

@steveklabnik
Copy link
Member

(And, is partially covered by all the "all API docs" metabug)

@glandium
Copy link
Contributor Author

Is there an type of markdown annotation that would automatically consider those as types? After looking around, it doesn't seem to. On the contrary, it seems one needs to put explicit links manually, as in https://doc.rust-lang.org/src/core/up/src/libcore/any.rs.html#20.

I'd argue it would be nice if rustdoc allowed to annotate things in a way such that types can be linked properly without having to add explicit links to ../../std/(...)

@steveklabnik
Copy link
Member

Not currently, but see rust-lang/rfcs#1661

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