Improve handling of rustdoc lints when used with raw doc fragments. #136400

lolbinarycat · 2025-02-01T21:03:51Z

rustdoc::bare_urls no longer outputs incoherent suggestions if source_span_for_markdown_range returns None, instead outputting no suggestion
source_span_for_markdown_range has one more heuristic, so it will return None less often.
add ui test to make sure we don't emit nonsense suggestions.

rustbot · 2025-02-01T21:03:58Z

rustbot has assigned @fmease.
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

compiler/rustc_resolve/src/rustdoc.rs

lolbinarycat · 2025-02-06T22:07:45Z

@fmease what module do you want me to move source_span_to_markdown_range into, or should that be left for a followup PR?

lolbinarycat · 2025-03-13T20:09:34Z

@fmease reminder to look at this.

lolbinarycat · 2025-03-22T23:03:12Z

@fmease it's been a week, are you going to get to this, or should I reroll reviewers?

src/librustdoc/passes/lint/bare_urls.rs

compiler/rustc_resolve/src/rustdoc.rs

tests/rustdoc-ui/lints/bare-urls-limit.rs

fmease · 2025-04-02T12:16:41Z

@bors try @rust-timer queue

…1, r=<try> Improve handling of rustdoc lints when used with raw doc fragments. 1. `rustdoc::bare_urls` no longer outputs incoherent suggestions if `source_span_for_markdown_range` returns None, instead outputting no suggestion 2. `source_span_for_markdown_range` has one more heuristic, so it will return `None` less often. 3. add ui test to make sure we don't emit nonsense suggestions. fixes rust-lang#135851

bors · 2025-04-02T12:17:58Z

⌛ Trying commit c6d7696 with merge 75eefd1...

bors · 2025-04-02T14:24:42Z

☀️ Try build successful - checks-actions
Build commit: 75eefd1 (75eefd14476b7cd550f9b8b82f8fccfa949bf30e)

rust-timer · 2025-04-02T16:49:32Z

Finished benchmarking commit (75eefd1): comparison URL.

Overall result: no relevant changes - no action needed

Benchmarking this pull request likely means that it is perf-sensitive, so we're automatically marking it as not fit for rolling up. While you can manually mark this PR as fit for rollup, we strongly recommend not doing so since this PR may lead to changes in compiler perf.

@bors rollup=never
@rustbot label: -S-waiting-on-perf -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results (secondary -4.0%)

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-4.0%	[-5.0%, -3.0%]	2
All ❌✅ (primary)	-	-	0

Cycles

This benchmark run did not return any relevant results for this metric.

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 776.227s -> 775.389s (-0.11%)
Artifact size: 365.99 MiB -> 365.98 MiB (-0.00%)

lolbinarycat · 2025-04-02T19:02:11Z

@fmease all recommended changes added

compiler/rustc_resolve/src/rustdoc.rs

src/librustdoc/passes/lint/bare_urls.rs

GuillaumeGomez

Code logic is good, just some nits and then it's good to go.

lolbinarycat · 2025-05-16T08:39:16Z

Addressed all nits and squashed commits! @GuillaumeGomez @fmease

1. rustdoc::bare_urls doesn't output invalid suggestions if source_span_for_markdown_range fails to find a span 2. source_span_for_markdown_range tries harder to return a span by applying an additional diagnostic fixes rust-lang#135851

GuillaumeGomez · 2025-05-22T20:49:49Z

Looks all good to me. This is a very nice improvement, thanks!

@bors r+ rollup

bors · 2025-05-22T20:49:52Z

📌 Commit 3005a09 has been approved by GuillaumeGomez

It is now in the queue for this repository.

…851, r=GuillaumeGomez Improve handling of rustdoc lints when used with raw doc fragments. 1. `rustdoc::bare_urls` no longer outputs incoherent suggestions if `source_span_for_markdown_range` returns None, instead outputting no suggestion 2. `source_span_for_markdown_range` has one more heuristic, so it will return `None` less often. 3. add ui test to make sure we don't emit nonsense suggestions. fixes rust-lang#135851

…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#136400 (Improve handling of rustdoc lints when used with raw doc fragments.) - rust-lang#140967 (Async drop poll shim for error dropee generates noop body) - rust-lang#141019 (Update std doctests for android) - rust-lang#141062 (Update IDEs to use rustfmt 2024, fix Zed settings) - rust-lang#141109 (discuss deadlocks in the std::io::pipe() example) - rust-lang#141126 (rustdoc JSON: Don't apply `#[repr]` privacy heuristics) - rust-lang#141376 (Rename `kw::Empty` as `sym::empty`.) - rust-lang#141383 (Miri subtree update) r? `@ghost` `@rustbot` modify labels: rollup

Rollup of 7 pull requests Successful merges: - #136400 (Improve handling of rustdoc lints when used with raw doc fragments.) - #140967 (Async drop poll shim for error dropee generates noop body) - #141019 (Update std doctests for android) - #141109 (discuss deadlocks in the std::io::pipe() example) - #141126 (rustdoc JSON: Don't apply `#[repr]` privacy heuristics) - #141376 (Rename `kw::Empty` as `sym::empty`.) - #141383 (Miri subtree update) r? `@ghost` `@rustbot` modify labels: rollup

rustbot assigned fmease Feb 1, 2025

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 Feb 1, 2025

This comment has been minimized.

Sign in to view

lolbinarycat force-pushed the rustdoc-link-lint-135851 branch from a9a435b to c6d7696 Compare February 3, 2025 19:23

petrochenkov reviewed Feb 3, 2025

View reviewed changes

compiler/rustc_resolve/src/rustdoc.rs Show resolved Hide resolved

lolbinarycat mentioned this pull request Feb 6, 2025

move tests from tests/rustdoc-ui/ to tests/rustdoc-ui/lints/ where applicable #136501

Open

fmease reviewed Apr 2, 2025

View reviewed changes

src/librustdoc/passes/lint/bare_urls.rs Outdated Show resolved Hide resolved

compiler/rustc_resolve/src/rustdoc.rs Show resolved Hide resolved

tests/rustdoc-ui/lints/bare-urls-limit.rs Outdated Show resolved Hide resolved

fmease closed this Apr 2, 2025

fmease reopened this Apr 2, 2025

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 Apr 2, 2025

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 Apr 2, 2025

GuillaumeGomez reviewed May 14, 2025

View reviewed changes

compiler/rustc_resolve/src/rustdoc.rs Outdated Show resolved Hide resolved

GuillaumeGomez reviewed May 14, 2025

View reviewed changes

compiler/rustc_resolve/src/rustdoc.rs Outdated Show resolved Hide resolved

GuillaumeGomez reviewed May 14, 2025

View reviewed changes

compiler/rustc_resolve/src/rustdoc.rs Outdated Show resolved Hide resolved

fmease reviewed May 14, 2025

View reviewed changes

compiler/rustc_resolve/src/rustdoc.rs Outdated Show resolved Hide resolved

GuillaumeGomez reviewed May 14, 2025

View reviewed changes

src/librustdoc/passes/lint/bare_urls.rs Outdated Show resolved Hide resolved

GuillaumeGomez requested changes May 14, 2025

View reviewed changes

lolbinarycat force-pushed the rustdoc-link-lint-135851 branch from fe5bccb to 0d3d650 Compare May 16, 2025 08:38

This comment has been minimized.

Sign in to view

lolbinarycat force-pushed the rustdoc-link-lint-135851 branch from 0d3d650 to ec390f0 Compare May 16, 2025 09:48

This comment has been minimized.

Sign in to view

lolbinarycat force-pushed the rustdoc-link-lint-135851 branch from ec390f0 to dce6e86 Compare May 21, 2025 14:52

This comment has been minimized.

Sign in to view

lolbinarycat force-pushed the rustdoc-link-lint-135851 branch from dce6e86 to c83a7b1 Compare May 21, 2025 16:04

This comment has been minimized.

Sign in to view

lolbinarycat force-pushed the rustdoc-link-lint-135851 branch 2 times, most recently from 52a0e28 to 314ac89 Compare May 22, 2025 17:06

This comment has been minimized.

Sign in to view

rustdoc: improve diagnostics on raw doc fragments

3005a09

1. rustdoc::bare_urls doesn't output invalid suggestions if source_span_for_markdown_range fails to find a span 2. source_span_for_markdown_range tries harder to return a span by applying an additional diagnostic fixes rust-lang#135851

lolbinarycat force-pushed the rustdoc-link-lint-135851 branch from 314ac89 to 3005a09 Compare May 22, 2025 17:31

fmease assigned GuillaumeGomez and unassigned fmease May 22, 2025

GuillaumeGomez approved these changes May 22, 2025

View reviewed changes

bors 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 May 22, 2025

matthiaskrgr mentioned this pull request May 23, 2025

Rollup of 8 pull requests #141420

Closed

matthiaskrgr mentioned this pull request May 23, 2025

Rollup of 7 pull requests #141437

Merged

bors merged commit 1c2ea28 into rust-lang:master May 23, 2025
6 checks passed

rustbot added this to the 1.89.0 milestone May 23, 2025

Improve handling of rustdoc lints when used with raw doc fragments. #136400

Improve handling of rustdoc lints when used with raw doc fragments. #136400

Conversation

lolbinarycat commented Feb 1, 2025

Uh oh!

rustbot commented Feb 1, 2025

Uh oh!

This comment has been minimized.

This comment has been minimized.

Uh oh!

lolbinarycat commented Feb 6, 2025

Uh oh!

lolbinarycat commented Mar 13, 2025

Uh oh!

lolbinarycat commented Mar 22, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fmease commented Apr 2, 2025

Uh oh!

This comment has been minimized.

bors commented Apr 2, 2025

Uh oh!

bors commented Apr 2, 2025

Uh oh!

This comment has been minimized.

rust-timer commented Apr 2, 2025

Overall result: no relevant changes - no action needed

Instruction count

Max RSS (memory usage)

Cycles

Binary size

Uh oh!

lolbinarycat commented Apr 2, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GuillaumeGomez left a comment

Choose a reason for hiding this comment

Uh oh!

lolbinarycat commented May 16, 2025

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

GuillaumeGomez commented May 22, 2025

Uh oh!

bors commented May 22, 2025

Uh oh!

Uh oh!

Uh oh!