-
Notifications
You must be signed in to change notification settings - Fork 12.8k
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
Improve Rustdoc self-documentation visibility by displaying links in usage #76427
Improve Rustdoc self-documentation visibility by displaying links in usage #76427
Conversation
r? @ollie27 (rust_highfive has picked a reviewer for you, use r? to override) |
Hmm, I'm a little unsure about this. None of the other tools do anything similar (I tried |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you also print this message after the rustdoc [options] <input>
snippet, not before?
println!("rustdoc usage is documented online https://doc.rust-lang.org/rustdoc/"); | ||
if nightly_options::is_nightly_build() { | ||
println!("nightly rustdoc includes additional features https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc/"); | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should only link to one or the other I think.
println!("rustdoc usage is documented online https://doc.rust-lang.org/rustdoc/"); | |
if nightly_options::is_nightly_build() { | |
println!("nightly rustdoc includes additional features https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc/"); | |
} | |
let url = if nightly_options::is_nightly_build() { | |
"https://doc.rust-lang.org/nightly/rustdoc/" | |
} else { | |
"https://doc.rust-lang.org/rustdoc/" | |
}; | |
println!("Documentation: {}", url); |
I'm really unsure about this too... This is an interesting take to the problem though... |
@AndyGauge Ping from triage, CI is still red here. Would you mind fixing it? Also, please try to discuss this will rustdoc team to reach agreement on this, maybe by asking on rustdoc channel on Discord. |
@AndyGauge thanks for taking the time to contribute. I have to close this due to inactivity. If you wish and you have the time you can open a new PR with these changes and we'll take it from there. Thanks |
Yeah, I think I misunderstood the requirements 💯 |
fixes #75520