-
Notifications
You must be signed in to change notification settings - Fork 12.6k
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
[rustdoc] Rustdoc should render crate examples and link to them on main documentation page #34022
Comments
burtonageo
changed the title
[rustdoc] Rustic should render crate examples and link to them on main documentation page
[rustdoc] Rustdoc should render crate examples and link to them on main documentation page
Jun 1, 2016
Related to, but not the same as, #16103 rust-lang/cargo#739 |
Ah, this was filed in the rust repo, not the cargo repo. @burtonageo mind re-filing https:/rust-lang/cargo/issues/new thanks! |
(Specifically, because "examples" are a Cargo feature, not a Rust feature) |
@steveklabnik Done, thanks |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Cargo allows crate developers to create examples to show off their crate's API (as shown in http://doc.crates.io/guide.html#project-layout). These examples are very useful to see how the individual items in a crate can be used together, in a way that the standard documentation doesn't capture very well.
When viewing a crate's documentation, it would be useful if examples were rendered as standard source files, and there were links to view them on the main library overview page.
The text was updated successfully, but these errors were encountered: