rust-lang / rust-lang/rust

Rustdoc `--sort-modules-by-appearance` sometimes doesn't respect order

Open
#150,634 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-bug requires-nightly T-rustdoc
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

Code

/// should occur first
pub use std::mem::drop;

pub use inner::yyy;

mod inner {
    /// should occur second
    pub fn yyy() {}
}

Reproduction Steps

run rustdoc with -Z unstable-options --sort-modules-by-appearance

Expected Outcome

drop should occur first, yyy second

Actual Output

yyy first, drop second

Version

rustdoc 1.94.0-nightly (806c2a35d 2025-12-19)

Additional Details

If i replace reexported drop with a locally defined exported function, the issue doesn't occur.

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 running rustdoc with -Z unstable-options --sort-modules-by-appearance on the provided Rust snippet and confirm the re-exported drop appears after yyy. Trace the rustdoc handling of this option, then add coverage showing that the re-export preserves source order and verify that the output lists drop first.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.