rust-lang / rust-lang/rust

rustdoc CURRENT_RUSTC_VERSION shows incorrect version between version bump and stage0 bump

Open
#126,357 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-docs C-bug T-bootstrap T-rustdoc
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

Items marked with the stability attribute and CURRENT_RUSTC_VERSION will show the wrong version in nightly rustdoc output in between the version bump and the stage0 bump. That means in this sequence:

  1. Item gets marked with CURRENT_RUSTC_VERSION. Example, on nightly the current rust version is 1.80, which is what rustdoc shows.
  2. Version is bumped example bumps to 1.81.
  3. Nightly docs for CURRENT_RUSTC_VERSION marked items now show 1.81 when they should say 1.80.
  4. Stage0 is bumped, and CURRENT_RUSTC_VERSION placeholders get replaced example. The item is now correctly marked 1.80.

This can be confusing since there can be a window of several days where the wrong version is displayed.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how rustdoc handles CURRENT_RUSTC_VERSION during the version bump and stage0 bump sequence, using the two referenced pull requests as context. Reproduce the nightly output during that interval and confirm that marked items retain the correct version after the version bump; done means the misleading multi-day window is eliminated.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.