Skip to content

Rustdoc incorrectly fires redundant_explicit_link warning #123677

Closed
@BD103

Description

@BD103

We've recently begun testing Bevy against the beta toolchain, where it has incorrectly raised an rustdoc::redundant_explicit_links lint against this lint.

/// Determines how frequently an [`App`](bevy_app::App) should update.
///
/// **Note:** This setting is independent of VSync. VSync is controlled by a window's
/// [`PresentMode`](bevy_window::PresentMode) setting. If an app can update faster than the refresh
/// rate, but VSync is enabled, the update rate will be indirectly limited by the renderer.
#[derive(Debug, Clone, Copy)]
pub enum UpdateMode {
   // ...

bevy_app::App is not imported in this file, yet rustdoc believes that it is. (See the imports here.) As a temporary workaround, I've created bevyengine/bevy#12913 to ignore the error.

Here is the job that first failed. In case it expires, here's this archive. Look at 1_check-doc.txt.

I can reproduce it on this commit using rustc 1.78.0-beta.5 by running the following command:

$ cargo doc -p bevy_winit --no-deps

The --no-deps is optional, but it makes the command finish quicker. I'll continue testing to see if I can create a minimum reproducible example.

Meta

rustc --version --verbose:

rustc 1.78.0-beta.5 (9eff51035 2024-04-06)
binary: rustc
commit-hash: 9eff5103597e0ce73244028c96c75866dbcbad1d
commit-date: 2024-04-06
host: aarch64-apple-darwin
release: 1.78.0-beta.5
LLVM version: 18.1.2

Metadata

Metadata

Assignees

Labels

A-lintsArea: Lints (warnings about flaws in source code) such as unused_mut.C-bugCategory: This is a bug.P-highHigh priorityS-has-mcveStatus: A Minimal Complete and Verifiable Example has been found for this issueT-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.regression-from-stable-to-betaPerformance or correctness regression from stable to beta.

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions