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

[rustdoc] Rustdoc should render crate examples and link to them on main documentation page #34022

Closed
burtonageo opened this issue Jun 1, 2016 · 4 comments

Comments

@burtonageo
Copy link
Contributor

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.

@burtonageo 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
@steveklabnik
Copy link
Member

Related to, but not the same as, #16103 rust-lang/cargo#739

@steveklabnik
Copy link
Member

Ah, this was filed in the rust repo, not the cargo repo. @burtonageo mind re-filing https://github.com/rust-lang/cargo/issues/new thanks!

@steveklabnik
Copy link
Member

(Specifically, because "examples" are a Cargo feature, not a Rust feature)

@burtonageo
Copy link
Contributor Author

@steveklabnik Done, thanks

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

2 participants