rustdoc: do not include extra stuff in span by notriddle · Pull Request #157561 · rust-lang/rust

notriddle · 2026-06-07T05:26:12Z

This change prevents our lints from returning a span with stuff in it that isn't actually part of the doc comment. When that happens, it returns None instead.

Fixes rust-lang/rust-clippy#16169, since the bug was reported against the clippy::doc_paragraphs_missing_punctuation lint but is actually a bug in source_span_for_markdown_range_inner.

rustbot · 2026-06-07T05:26:17Z

r? @lolbinarycat

rustbot has assigned @lolbinarycat.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

Why was this reviewer chosen?

The reviewer was selected based on:

Owners of files modified in this PR: rustdoc
rustdoc expanded to 9 candidates
Random selection from GuillaumeGomez, camelid, lolbinarycat

notriddle · 2026-06-07T05:27:18Z

p.s. this change is a lot easier to understand if you use the hide whitespace setting on the diff.

rustbot · 2026-06-08T00:46:28Z

The Clippy subtree was changed

cc @rust-lang/clippy

lolbinarycat · 2026-06-13T02:00:50Z

Do we need to be optimizing our diagnostic code (cold path) to the extent of using binary search to find an item in a usually small list? this only speeds up doc generation if a crate has a ton of warnings. I guess I'll see if it shows up at all in a perf run.

@bors try @rust-timer queue profiles=doc

rustdoc: do not include extra stuff in span

rust-bors · 2026-06-13T04:16:51Z

☀️ Try build successful (CI)
Build commit: a64b630 (a64b630f04e7c6ae84c88850e738cae44ce235d7, parent: 65407954098ca3c19f0d46092cb374b5d3e9dc3c)

rust-timer · 2026-06-13T04:34:58Z

Finished benchmarking commit (a64b630): comparison URL.

Overall result: no relevant changes - no action needed

Benchmarking means the PR may be perf-sensitive. Consider adding rollup=never if this change is not fit for rolling up.

@rustbot label: -S-waiting-on-perf -perf-regression

Instruction count

This perf run didn't have relevant results for this metric.

Max RSS (memory usage)

This perf run didn't have relevant results for this metric.

Cycles

This perf run didn't have relevant results for this metric.

Binary size

This perf run didn't have relevant results for this metric.

Bootstrap: 518.069s -> 524.961s (1.33%)
Artifact size: 401.35 MiB -> 401.38 MiB (0.01%)

notriddle · 2026-06-13T04:43:52Z

Do we need to be optimizing our diagnostic code (cold path) to the extent of using binary search to find an item in a usually small list?

I knew it would be O(n²) if just did a linear scan. Even in the cold path, I'd prefer to avoid that.

rustbot · 2026-06-26T16:51:04Z

This PR was rebased onto a different main commit. Here's a range-diff highlighting what actually changed.

Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers.

lolbinarycat

A few more improvements, then you can r=me

View changes since this review

Co-authored-by: lolbinarycat <dogedoge61+github@gmail.com>

notriddle · 2026-07-07T14:16:30Z

@bors r=lolbinarycat

rust-bors · 2026-07-07T14:16:34Z

📌 Commit fd07857 has been approved by lolbinarycat

It is now in the queue for this repository.

…name, r=lolbinarycat rustdoc: do not include extra stuff in span This change prevents our lints from returning a span with stuff in it that isn't actually part of the doc comment. When that happens, it returns `None` instead. Fixes rust-lang/rust-clippy#16169, since the bug was reported against the `clippy::doc_paragraphs_missing_punctuation` lint but is actually a bug in `source_span_for_markdown_range_inner`.

…uwer Rollup of 18 pull requests Successful merges: - #157385 (Enable Enzyme on x86_64-apple) - #157561 (rustdoc: do not include extra stuff in span) - #158179 (std: unconditionally use `preadv`/`pwritev` on AArch64 macOS) - #158617 (allow mGCA const arguments to fall back to anon consts) - #158621 (disallow `extern "custom"` on wasm and spirv targets) - #158690 (delegation: support mapping of all arguments with `Self` type) - #158696 (Rename some `body_id` to `body_def_id`) - #158697 (Fixes for QNX SDP 8) - #158760 (Clarify that `LocalKey::try_with` may return `AccessError`) - #157801 (Rewrite safety requirements for `Allocator` impls) - #158333 (Fix typetree generation for differentiated functions) - #158646 (powerpc64le_unknown_freebsd.rs: link with -lgcc) - #158701 ( diagnostics: suggest type annotation for closure params on HRTB FnOnce mismatch) - #158791 (Avoid unused braces lint for macro generated arguments) - #158802 (Use `ci-mirrors` in `armhf-gnu` for {busybox, ubuntu rootfs} artifacts) - #158841 (Avoid final override ICE for RPITIT associated types) - #158889 (tests: catch up with LLVM returning f128 on the stack) - #158905 (delegation: add constraints to new generic args)

JonathanBrouwer · 2026-07-07T20:26:24Z

Probably this PR?
#158923 (comment)

@bors r-
@bors try jobs=dist-x86_64-linux-alt

rust-bors · 2026-07-07T20:26:31Z

This pull request was unapproved.

This PR was contained in a rollup (#158923), which was unapproved.

View changes since this unapproval

rustdoc: do not include extra stuff in span try-job: dist-x86_64-linux-alt

rust-bors · 2026-07-07T21:13:06Z

💔 Test for 06b5f85 failed: CI. Failed job:

try - dist-x86_64-linux-alt (web logs, enhanced plaintext logs)

This is a weird, but unrelated, problem with doc comments and attribute macros. If I remove the `#[instrument]` attribute, the lint behaves the way it's supposed to, and points directly at the link instead of pointing at the whole line. warning: redundant explicit link target --> compiler/rustc_hir_analysis/src/hir_ty_lowering/mod.rs:2373:5 | 2373 | /// Lower a [`hir::ConstArg`] to a (type-level) [`ty::Const`](Const). | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ explicit target `Const` is redundant because label `ty::Const` resolves to same destination | = note: when a link's destination is not specified, the label is used to resolve intra-doc links = note: `#[warn(rustdoc::redundant_explicit_links)]` on by default

rustbot · 2026-07-09T16:06:38Z

HIR ty lowering was modified

cc @fmease

notriddle · 2026-07-09T16:07:11Z

@bors r=lolbinarycat

rust-bors · 2026-07-09T16:07:15Z

📌 Commit ebe343b has been approved by lolbinarycat

It is now in the queue for this repository.

…name, r=lolbinarycat rustdoc: do not include extra stuff in span This change prevents our lints from returning a span with stuff in it that isn't actually part of the doc comment. When that happens, it returns `None` instead. Fixes rust-lang/rust-clippy#16169, since the bug was reported against the `clippy::doc_paragraphs_missing_punctuation` lint but is actually a bug in `source_span_for_markdown_range_inner`.

rustbot assigned lolbinarycat Jun 7, 2026

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jun 7, 2026

This comment has been minimized.

Sign in to view

notriddle force-pushed the do-not-destroy-function-name branch from d2784cd to 9af61c5 Compare June 7, 2026 05:52

This comment has been minimized.

Sign in to view

notriddle force-pushed the do-not-destroy-function-name branch from 9af61c5 to 7db2845 Compare June 7, 2026 07:05

This comment has been minimized.

Sign in to view

notriddle force-pushed the do-not-destroy-function-name branch from 7db2845 to 9d216d1 Compare June 7, 2026 15:26

This comment has been minimized.

Sign in to view

notriddle force-pushed the do-not-destroy-function-name branch from 31c9e0e to d13270c Compare June 8, 2026 02:23

rustbot added the T-clippy Relevant to the Clippy team. label Jun 8, 2026

notriddle requested a review from lolbinarycat June 8, 2026 04:07

This comment has been minimized.

Sign in to view

notriddle force-pushed the do-not-destroy-function-name branch from d13270c to 33fb30e Compare June 12, 2026 16:54

This comment has been minimized.

Sign in to view

rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Jun 13, 2026

This comment has been minimized.

Sign in to view

rust-bors Bot pushed a commit that referenced this pull request Jun 13, 2026

Auto merge of #157561 - notriddle:do-not-destroy-function-name, r=<try>

a64b630

rustdoc: do not include extra stuff in span

This comment has been minimized.

Sign in to view

rustbot removed the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Jun 13, 2026

lolbinarycat reviewed Jul 6, 2026

View reviewed changes

Comment thread compiler/rustc_resolve/src/rustdoc.rs

Comment thread compiler/rustc_resolve/src/rustdoc.rs Outdated

Comment thread src/librustdoc/passes/lint/redundant_explicit_links.rs Outdated

notriddle and others added 3 commits July 7, 2026 00:15

Add diagram to comment

042e779

Co-authored-by: lolbinarycat <dogedoge61+github@gmail.com>

Fix wrong diagram in comment

8f1fd2c

Co-authored-by: lolbinarycat <dogedoge61+github@gmail.com>

Use better name for lint struct

fd07857

Co-authored-by: lolbinarycat <dogedoge61+github@gmail.com>

rust-bors Bot added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 7, 2026

JonathanBrouwer mentioned this pull request Jul 7, 2026

Rollup of 7 pull requests #158919

Closed

JonathanBrouwer mentioned this pull request Jul 7, 2026

Rollup of 18 pull requests #158923

Closed

rust-bors Bot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jul 7, 2026

This comment has been minimized.

Sign in to view

rust-bors Bot pushed a commit that referenced this pull request Jul 7, 2026

Auto merge of #157561 - notriddle:do-not-destroy-function-name, r=<try>

06b5f85

rustdoc: do not include extra stuff in span try-job: dist-x86_64-linux-alt

This comment has been minimized.

Sign in to view

rust-bors Bot added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jul 9, 2026

JonathanBrouwer mentioned this pull request Jul 9, 2026

Rollup of 24 pull requests #159037

Open

Uh oh!

Uh oh!

Conversation

notriddle commented Jun 7, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Jun 7, 2026

Uh oh!

notriddle commented Jun 7, 2026

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

rustbot commented Jun 8, 2026

Uh oh!

This comment has been minimized.

This comment has been minimized.

lolbinarycat commented Jun 13, 2026

Uh oh!

This comment has been minimized.

This comment has been minimized.

rust-bors Bot commented Jun 13, 2026

Uh oh!

This comment has been minimized.

rust-timer commented Jun 13, 2026

Overall result: no relevant changes - no action needed

Instruction count

Max RSS (memory usage)

Cycles

Binary size

Uh oh!

notriddle commented Jun 13, 2026

Uh oh!

rustbot commented Jun 26, 2026

Uh oh!

lolbinarycat left a comment • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

notriddle commented Jul 7, 2026

Uh oh!

rust-bors Bot commented Jul 7, 2026

Uh oh!

JonathanBrouwer commented Jul 7, 2026

Uh oh!

rust-bors Bot commented Jul 7, 2026

Uh oh!

This comment has been minimized.

rust-bors Bot commented Jul 7, 2026

Uh oh!

This comment has been minimized.

rustbot commented Jul 9, 2026

Uh oh!

notriddle commented Jul 9, 2026

Uh oh!

rust-bors Bot commented Jul 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

notriddle commented Jun 7, 2026 •

edited by rustbot

Loading

lolbinarycat left a comment •

edited by rustbot

Loading