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

Rust API Guideline: Crate sets html_root_url attribute #1788

Open
clarfonthey opened this issue May 27, 2017 · 4 comments
Open

Rust API Guideline: Crate sets html_root_url attribute #1788

clarfonthey opened this issue May 27, 2017 · 4 comments
Labels
L-guidelines Lint: Related to the Rust API Guidelines

Comments

@clarfonthey
Copy link
Contributor

We shouldn't do this for crates which have documentation turned off in Cargo.toml.

@mcarton
Copy link
Member

mcarton commented May 27, 2017

Can you provide some information about this attribute? I don't know what that would be necessary (don't even know what that does).
I see it's a guideline, but there is no rationnal and it is merely mentionned in the book.

@mcarton mcarton changed the title Lint crates which don't provide doc(html_root_url) Rust API Guideline: Crate sets html_root_url attribute May 27, 2017
@clarfonthey
Copy link
Contributor Author

@mcarton this provides a canonical URL where rustdoc can redirect URLs for a crate. It's how links to libstd get redirected to doc.rust-lang.org, and it makes it easier to allow interop between rustdocs without having to include local docs for dependency crates all the time.

@mcarton
Copy link
Member

mcarton commented May 28, 2017

@dtolnay has open an issue on the guidelines to document that one better rust-lang/api-guidelines#75 ❤️

@mcarton mcarton added the L-guidelines Lint: Related to the Rust API Guidelines label May 28, 2017
@jyn514
Copy link
Member

jyn514 commented Nov 18, 2020

See rust-lang/api-guidelines#229 for more information about this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
L-guidelines Lint: Related to the Rust API Guidelines
Projects
None yet
Development

No branches or pull requests

3 participants