Correctly handle comments in attributes in doctests source code by GuillaumeGomez · Pull Request #134260 · rust-lang/rust

GuillaumeGomez · 2024-12-13T15:21:40Z

The problem was that attributes are "inlined" (backlines are stripped), then when there is an inline comment inside it, the attribute is never considered valid (since unclosed). Fix was to simply put back backlines in case it's a multiline attribute.

r? @notriddle

GuillaumeGomez · 2024-12-13T16:11:06Z

Forgot to set only one test thread to prevent having fuzzy sorting...

GuillaumeGomez · 2024-12-13T17:14:51Z

And to replace stdout for time too...

cyrgani · 2024-12-13T18:28:31Z

Does this also fix that

//! ```rust
//! #![
//! ```

is incorrectly treated as a sucessful test?

GuillaumeGomez · 2024-12-16T12:59:51Z

Now it does. :)

GuillaumeGomez · 2024-12-16T14:15:27Z

Ready for review.

notriddle · 2024-12-16T16:49:45Z

src/librustdoc/doctest/make.rs

    } else if mod_attr_pending.ends_with('\\') {
        mod_attr_pending.push('n');


If I understand this correctly, these lines aren't really needed any more. They would have turned

#[doc="first\ second"]

into

#[doc="first\nsecond"]

But that only works with double-quoted strings, not raw strings, and is unnecessary now that newlines are preserved here.

Suggested change

} else if mod_attr_pending.ends_with('\\') {

mod_attr_pending.push('n');

Adding a test just in case.

GuillaumeGomez · 2024-12-16T17:03:38Z

Removed the backline handling and also added a regression test for it.

notriddle · 2024-12-16T18:13:05Z

@bors r+ rollup

bors · 2024-12-16T18:13:08Z

📌 Commit c367cc3 has been approved by notriddle

It is now in the queue for this repository.

…triddle Correctly handle comments in attributes in doctests source code Fixes rust-lang#134221. The problem was that attributes are "inlined" (backlines are stripped), then when there is an inline comment inside it, the attribute is never considered valid (since unclosed). Fix was to simply put back backlines in case it's a multiline attribute. r? `@notriddle`

…triddle Correctly handle comments in attributes in doctests source code Fixes rust-lang#134221. The problem was that attributes are "inlined" (backlines are stripped), then when there is an inline comment inside it, the attribute is never considered valid (since unclosed). Fix was to simply put back backlines in case it's a multiline attribute. r? ``@notriddle``

…triddle Correctly handle comments in attributes in doctests source code Fixes rust-lang#134221. The problem was that attributes are "inlined" (backlines are stripped), then when there is an inline comment inside it, the attribute is never considered valid (since unclosed). Fix was to simply put back backlines in case it's a multiline attribute. r? ```@notriddle```

…llaumeGomez Rollup of 9 pull requests Successful merges: - rust-lang#132056 (Stabilize `#[diagnostic::do_not_recommend]`) - rust-lang#134124 (CI: use free runners for x86_64-gnu-llvm jobs) - rust-lang#134197 (rustc_mir_build: Clarify that 'mirrored' does not mean 'flipped' or 'reversed') - rust-lang#134260 (Correctly handle comments in attributes in doctests source code) - rust-lang#134277 (rustdoc-search: handle `impl Into<X>` better) - rust-lang#134284 (Keep track of patterns that could have introduced a binding, but didn't) - rust-lang#134337 (reject unsound toggling of RISCV target features) - rust-lang#134385 (tests/ui/asm: Remove uses of rustc_attrs, lang_items, and decl_macro features by using minicore) - rust-lang#134386 (Some trait method vs impl method signature difference diagnostic cleanups) r? `@ghost` `@rustbot` modify labels: rollup

…iaskrgr Rollup of 9 pull requests Successful merges: - rust-lang#134124 (CI: use free runners for x86_64-gnu-llvm jobs) - rust-lang#134197 (rustc_mir_build: Clarify that 'mirrored' does not mean 'flipped' or 'reversed') - rust-lang#134260 (Correctly handle comments in attributes in doctests source code) - rust-lang#134277 (rustdoc-search: handle `impl Into<X>` better) - rust-lang#134284 (Keep track of patterns that could have introduced a binding, but didn't) - rust-lang#134337 (reject unsound toggling of RISCV target features) - rust-lang#134371 (Check for array lengths that aren't actually `usize`) - rust-lang#134385 (tests/ui/asm: Remove uses of rustc_attrs, lang_items, and decl_macro features by using minicore) - rust-lang#134386 (Some trait method vs impl method signature difference diagnostic cleanups) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#134260 - GuillaumeGomez:doctest-attrs, r=notriddle Correctly handle comments in attributes in doctests source code Fixes rust-lang#134221. The problem was that attributes are "inlined" (backlines are stripped), then when there is an inline comment inside it, the attribute is never considered valid (since unclosed). Fix was to simply put back backlines in case it's a multiline attribute. r? ``@notriddle``

GuillaumeGomez · 2024-12-17T19:02:31Z

Nominating it for beta backporting.

[beta] backports - Do not call `extern_crate` on current trait on crate mismatch errors rust-lang#133585 - Correctly handle comments in attributes in doctests source code rust-lang#134260 - Correctly document CTFE behavior of is_null and methods that call is_null. rust-lang#134325 - Make sure we handle `backwards_incompatible_lint` drops appropriately in drop elaboration rust-lang#134486 - Bump compiler `cc` to 1.2.5 rust-lang#134505 - Handle `DropKind::ForLint` in coroutines correctly rust-lang#134575 - docs: inline `std::ffi::c_str` types to `std::ffi` rust-lang#134791 - docs: inline `alloc::ffi::c_str` types to `alloc::ffi` rust-lang#134851 r? cuviper

Correctly handle comments in attributes in doctests source code

de16ed3

rustbot assigned notriddle Dec 13, 2024

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

GuillaumeGomez mentioned this pull request Dec 13, 2024

Adding a comment next to #![feature(ptr_metadata,)] silences failing doctests #134221

Closed

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the doctest-attrs branch from 700aac4 to f16ac84 Compare December 13, 2024 16:10

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the doctest-attrs branch from f16ac84 to a0b4038 Compare December 13, 2024 17:14

This comment has been minimized.

Sign in to view

GuillaumeGomez added 2 commits December 16, 2024 11:47

Add ui regression test for rust-lang#134221

9c4a61f

Also handle cases where attributes are unclosed

2383985

GuillaumeGomez force-pushed the doctest-attrs branch from a0b4038 to 2383985 Compare December 16, 2024 12:59

notriddle reviewed Dec 16, 2024

View reviewed changes

Remove unneeded handling of backlines in doctest attributes

c367cc3

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 Dec 16, 2024

GuillaumeGomez mentioned this pull request Dec 16, 2024

Rollup of 10 pull requests #134391

Closed

GuillaumeGomez mentioned this pull request Dec 16, 2024

Rollup of 10 pull requests #134392

Closed

GuillaumeGomez mentioned this pull request Dec 16, 2024

Rollup of 9 pull requests #134393

Closed

matthiaskrgr mentioned this pull request Dec 16, 2024

Rollup of 9 pull requests #134395

Merged

bors merged commit 9451a61 into rust-lang:master Dec 16, 2024

rustbot added this to the 1.85.0 milestone Dec 16, 2024

GuillaumeGomez deleted the doctest-attrs branch December 17, 2024 09:59

GuillaumeGomez added the beta-nominated Nominated for backporting to the compiler in the beta channel. label Dec 17, 2024

GuillaumeGomez added beta-accepted Accepted for backporting to the compiler in the beta channel. and removed beta-nominated Nominated for backporting to the compiler in the beta channel. labels Jan 2, 2025

cuviper added the beta-nominated Nominated for backporting to the compiler in the beta channel. label Jan 2, 2025

cuviper mentioned this pull request Jan 2, 2025

[beta] backports #135048

Merged

cuviper modified the milestones: 1.85.0, 1.84.0 Jan 2, 2025

cuviper removed the beta-nominated Nominated for backporting to the compiler in the beta channel. label Jan 2, 2025

		} else if mod_attr_pending.ends_with('\\') {
		mod_attr_pending.push('n');

Uh oh!

Conversation

GuillaumeGomez commented Dec 13, 2024

Uh oh!

This comment has been minimized.

GuillaumeGomez commented Dec 13, 2024

Uh oh!

This comment has been minimized.

GuillaumeGomez commented Dec 13, 2024

Uh oh!

This comment has been minimized.

cyrgani commented Dec 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GuillaumeGomez commented Dec 16, 2024

Uh oh!

GuillaumeGomez commented Dec 16, 2024

Uh oh!

notriddle Dec 16, 2024

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Dec 16, 2024

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez commented Dec 16, 2024

Uh oh!

notriddle commented Dec 16, 2024

Uh oh!

bors commented Dec 16, 2024

Uh oh!

GuillaumeGomez commented Dec 17, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

cyrgani commented Dec 13, 2024 •

edited

Loading