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 links to primitives hardcode /nightly #77775

Closed
jyn514 opened this issue Oct 10, 2020 · 1 comment · Fixed by #77827
Closed

rustdoc links to primitives hardcode /nightly #77775

jyn514 opened this issue Oct 10, 2020 · 1 comment · Fixed by #77827
Labels
C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jyn514
Copy link
Member

jyn514 commented Oct 10, 2020

I tried this code on the stable channel:

pub fn f() -> bool {
    true
}

I expected to see this happen: Rustdoc links bool to https://doc.rust-lang.org/std/primitive.bool.html

Instead, this happened: Rustdoc links bool to https://doc.rust-lang.org/nightly/std/primitive.bool.html

This also affects intra-doc links.

Meta

rustdoc --version: rustdoc 1.47.0 (18bf6b4f0 2020-10-07)

@jyn514 jyn514 added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-bug Category: This is a bug. labels Oct 10, 2020
@MouseProducedGames
Copy link

I can confirm this happens on the crates I've checked, which are crates known to build on the standard, non-nightly compiler.

I see two problems with this default behaviour:

  1. It can confuse users on whether a crate was compiled with +nightly or the standard compiler.
  2. More importantly, the behaviour described in the nightly documentation might not match the behaviour of the standard library linked to by a crate.

Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue Oct 16, 2020
…meGomez

Don't link to nightly primitives on stable channel

I am not sure how to test this.

Closes rust-lang#77775

r? @GuillaumeGomez
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Oct 16, 2020
…meGomez

Don't link to nightly primitives on stable channel

I am not sure how to test this.

Closes rust-lang#77775

r? @GuillaumeGomez
JohnTitor added a commit to JohnTitor/rust that referenced this issue Oct 16, 2020
…meGomez

Don't link to nightly primitives on stable channel

I am not sure how to test this.

Closes rust-lang#77775

r? @GuillaumeGomez
@bors bors closed this as completed in 8c4d855 Oct 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants