[rustdoc] Give more information into extracted doctest information #141399

GuillaumeGomez · 2025-05-22T15:52:20Z

Follow-up of #134531.

This update fragment the doctest code into its sub-parts to give more control to the end users on how they want to use it.

The new JSON looks like this:

{
  "format_version":2,
  "doctests":[
    {
      "file":"$DIR/extract-doctests-result.rs",
      "line":8,
      "doctest_attributes":{
        "original":"",
        "should_panic":false,
        "no_run":false,
        "ignore":"None",
        "rust":true,
        "test_harness":false,
        "compile_fail":false,
        "standalone_crate":false,
        "error_codes":[],
        "edition":null,
        "added_css_classes":[],
        "unknown":[]
      },
      "original_code":"let x = 12;\nOk(())",
      "doctest_code":{
        "crate_level":"#![allow(unused)]\n",
        "code":"let x = 12;\nOk(())",
        "wrapper":{
          "before":"fn main() { fn _inner() -> core::result::Result<(), impl core::fmt::Debug> {\n",
          "after":"\n} _inner().unwrap() }",
          "returns_result":true
        }
      },
      "name":"$DIR/extract-doctests-result.rs - (line 8)"
    }
  ]
}

for this doctest:

let x = 12;
Ok(())

With this, I think it matches what you need @ojeda? If so, once merged I'll update the patch I sent to RfL.

r? @aDotInTheVoid

GuillaumeGomez · 2025-05-22T16:09:35Z

Fixed fmt.

lolbinarycat

Core logic looks correct (mostly just exposing existing variables), just have a few nits about naming to hopefully increase readability.

src/librustdoc/doctest/make.rs

src/librustdoc/html/markdown.rs

GuillaumeGomez · 2025-05-23T09:34:58Z

Updated.

lolbinarycat

Looks pretty good, I've just got a few more notes about naming, most of which are extrapolations of previous suggested changes.

src/librustdoc/doctest/tests.rs

src/librustdoc/doctest.rs

src/librustdoc/doctest/extracted.rs

src/librustdoc/doctest/make.rs

aDotInTheVoid

This also needs changes to the docs for this feature, which are in the rustdoc book.

src/librustdoc/doctest/extracted.rs

GuillaumeGomez · 2025-06-04T16:46:23Z

Applied suggestions!

lolbinarycat

I don't think we should be putting the test stdout directly into the docs, at least not unmodified

src/doc/rustdoc/src/unstable-features.md

GuillaumeGomez · 2025-06-05T09:30:46Z

I fixed the book example.

rustbot · 2025-06-05T10:09:22Z

The Miri subtree was changed

cc @rust-lang/miri

Some changes occurred to the intrinsics. Make sure the CTFE / Miri interpreter
gets adapted for the changes, if necessary.

cc @rust-lang/miri, @RalfJung, @oli-obk, @lcnr

Some changes occurred in src/tools/clippy

cc @rust-lang/clippy

src/doc/rustdoc/src/unstable-features.md

bors · 2025-06-08T02:53:57Z

☔ The latest upstream changes (presumably #142181) made this pull request unmergeable. Please resolve the merge conflicts.

Improve code

GuillaumeGomez · 2025-06-10T12:03:45Z

Setting @aDotInTheVoid as reviewer since they already reviewed it and it's another JSON output. :)

r? aDotInTheVoid

rustbot · 2025-06-10T12:03:48Z

Requested reviewer is already assigned to this pull request.

Please choose another assignee.

src/doc/rustdoc/src/unstable-features.md

GuillaumeGomez · 2025-06-10T14:18:03Z

Added explanations in the rustdoc book about the new JSON fields.

GuillaumeGomez · 2025-06-11T10:02:48Z

Added an inner attribute to better show the difference between doctest_code and code.

src/doc/rustdoc/src/unstable-features.md

GuillaumeGomez · 2025-06-13T12:39:20Z

It's now ready for review. :)

aDotInTheVoid · 2025-06-13T22:53:43Z

@bors r+

bors · 2025-06-13T22:53:45Z

📌 Commit f1ceb07 has been approved by aDotInTheVoid

It is now in the queue for this repository.

…r=aDotInTheVoid [rustdoc] Give more information into extracted doctest information Follow-up of rust-lang#134531. This update fragment the doctest code into its sub-parts to give more control to the end users on how they want to use it. The new JSON looks like this: ```json { "format_version":2, "doctests":[ { "file":"$DIR/extract-doctests-result.rs", "line":8, "doctest_attributes":{ "original":"", "should_panic":false, "no_run":false, "ignore":"None", "rust":true, "test_harness":false, "compile_fail":false, "standalone_crate":false, "error_codes":[], "edition":null, "added_css_classes":[], "unknown":[] }, "original_code":"let x = 12;\nOk(())", "doctest_code":{ "crate_level":"#![allow(unused)]\n", "code":"let x = 12;\nOk(())", "wrapper":{ "before":"fn main() { fn _inner() -> core::result::Result<(), impl core::fmt::Debug> {\n", "after":"\n} _inner().unwrap() }", "returns_result":true } }, "name":"$DIR/extract-doctests-result.rs - (line 8)" } ] } ``` for this doctest: ```rust let x = 12; Ok(()) ``` With this, I think it matches what you need `@ojeda?` If so, once merged I'll update the patch I sent to RfL. r? `@aDotInTheVoid`

Rollup of 9 pull requests Successful merges: - #140593 (Temporary lifetime extension through tuple struct and tuple variant constructors) - #141399 ([rustdoc] Give more information into extracted doctest information) - #141493 (Delegate `<SocketAddr as Debug>` to `ByteStr`) - #141811 (Unimplement unsized_locals) - #142243 (float tests: deduplicate min, max, and rounding tests) - #142464 (variadic functions: remove list of supported ABIs from error) - #142477 (Fix incorrect suggestion when calling an associated type with a type anchor) - #142484 (Remove unneeded lifetime bound from signature of BTreeSet::extract_if) - #142489 (Update the `compiler-builtins` subtree) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of #141399 - GuillaumeGomez:extracted-doctest, r=aDotInTheVoid [rustdoc] Give more information into extracted doctest information Follow-up of #134531. This update fragment the doctest code into its sub-parts to give more control to the end users on how they want to use it. The new JSON looks like this: ```json { "format_version":2, "doctests":[ { "file":"$DIR/extract-doctests-result.rs", "line":8, "doctest_attributes":{ "original":"", "should_panic":false, "no_run":false, "ignore":"None", "rust":true, "test_harness":false, "compile_fail":false, "standalone_crate":false, "error_codes":[], "edition":null, "added_css_classes":[], "unknown":[] }, "original_code":"let x = 12;\nOk(())", "doctest_code":{ "crate_level":"#![allow(unused)]\n", "code":"let x = 12;\nOk(())", "wrapper":{ "before":"fn main() { fn _inner() -> core::result::Result<(), impl core::fmt::Debug> {\n", "after":"\n} _inner().unwrap() }", "returns_result":true } }, "name":"$DIR/extract-doctests-result.rs - (line 8)" } ] } ``` for this doctest: ```rust let x = 12; Ok(()) ``` With this, I think it matches what you need ``@ojeda?`` If so, once merged I'll update the patch I sent to RfL. r? ``@aDotInTheVoid``

rustbot assigned aDotInTheVoid May 22, 2025

GuillaumeGomez changed the title ~~Extracted doctest~~ [rustdoc] Give more information into extracted doctest information May 22, 2025

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the extracted-doctest branch from cd34db0 to 4e95830 Compare May 22, 2025 16:09

ojeda mentioned this pull request May 22, 2025

Rust unstable features needed for the kernel Rust-for-Linux/linux#2

Open

96 tasks

lolbinarycat reviewed May 22, 2025

View reviewed changes

GuillaumeGomez force-pushed the extracted-doctest branch from 4e95830 to 9888eb4 Compare May 23, 2025 09:34

lolbinarycat reviewed May 23, 2025

View reviewed changes

aDotInTheVoid requested changes May 26, 2025

View reviewed changes

src/librustdoc/doctest/extracted.rs Outdated Show resolved Hide resolved

rustbot 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-review Status: Awaiting review from the assignee but also interested parties. labels May 26, 2025

GuillaumeGomez force-pushed the extracted-doctest branch from 7447a70 to d7877b0 Compare June 4, 2025 15:17

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the extracted-doctest branch from d7877b0 to 38947d8 Compare June 4, 2025 15:42

lolbinarycat requested changes Jun 4, 2025

View reviewed changes

src/doc/rustdoc/src/unstable-features.md Outdated Show resolved Hide resolved

src/doc/rustdoc/src/unstable-features.md Outdated Show resolved Hide resolved

GuillaumeGomez force-pushed the extracted-doctest branch from ec02beb to d3bf6d5 Compare June 5, 2025 09:30

GuillaumeGomez force-pushed the extracted-doctest branch from d3bf6d5 to e361171 Compare June 5, 2025 10:09

rustbot added O-unix Operating system: Unix-like O-windows Operating system: Windows labels Jun 5, 2025

GuillaumeGomez force-pushed the extracted-doctest branch from e361171 to d3bf6d5 Compare June 5, 2025 10:10

oli-obk reviewed Jun 5, 2025

View reviewed changes

src/doc/rustdoc/src/unstable-features.md Outdated Show resolved Hide resolved

GuillaumeGomez force-pushed the extracted-doctest branch from d3bf6d5 to 0d048d5 Compare June 5, 2025 10:18

GuillaumeGomez added 4 commits June 10, 2025 13:54

Give more information into extracted doctest information

5864247

Add new extracted option doctest ui test for result returning doctest

21aabaf

Improve naming of variables in DocTestBuilder::generate_unique_doctest

eb61be3

Improve code

Add more tests to check extracted doctests feature

89e3510

GuillaumeGomez force-pushed the extracted-doctest branch from 0d048d5 to b82dd91 Compare June 10, 2025 12:00

This comment has been minimized.

Sign in to view

ojeda reviewed Jun 10, 2025

View reviewed changes

src/doc/rustdoc/src/unstable-features.md Outdated Show resolved Hide resolved

GuillaumeGomez force-pushed the extracted-doctest branch 2 times, most recently from 3bd04d1 to 051776c Compare June 10, 2025 14:17

GuillaumeGomez force-pushed the extracted-doctest branch from 051776c to c681e47 Compare June 11, 2025 10:02

ojeda reviewed Jun 11, 2025

View reviewed changes

src/doc/rustdoc/src/unstable-features.md Show resolved Hide resolved

Update extracted-doctest feature documentation

f1ceb07

GuillaumeGomez force-pushed the extracted-doctest branch from c681e47 to f1ceb07 Compare June 11, 2025 11:44

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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jun 13, 2025

jhpratt mentioned this pull request Jun 14, 2025

Rollup of 10 pull requests #142490

Closed

matthiaskrgr mentioned this pull request Jun 14, 2025

Rollup of 9 pull requests #142492

Merged

bors merged commit 9bdf5d3 into rust-lang:master Jun 14, 2025
10 checks passed

rustbot added this to the 1.89.0 milestone Jun 14, 2025

[rustdoc] Give more information into extracted doctest information #141399

[rustdoc] Give more information into extracted doctest information #141399

Conversation

GuillaumeGomez commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

GuillaumeGomez commented May 22, 2025

Uh oh!

lolbinarycat left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GuillaumeGomez commented May 23, 2025

Uh oh!

lolbinarycat left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aDotInTheVoid left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment has been minimized.

GuillaumeGomez commented Jun 4, 2025

Uh oh!

lolbinarycat left a comment • edited 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!

GuillaumeGomez commented Jun 5, 2025

Uh oh!

rustbot commented Jun 5, 2025

Uh oh!

Uh oh!

bors commented Jun 8, 2025

Uh oh!

GuillaumeGomez commented Jun 10, 2025

Uh oh!

rustbot commented Jun 10, 2025

Uh oh!

This comment has been minimized.

Uh oh!

GuillaumeGomez commented Jun 10, 2025

Uh oh!

GuillaumeGomez commented Jun 11, 2025

Uh oh!

Uh oh!

GuillaumeGomez commented Jun 13, 2025

Uh oh!

aDotInTheVoid commented Jun 13, 2025

Uh oh!

bors commented Jun 13, 2025

Uh oh!

Uh oh!

Uh oh!

GuillaumeGomez commented May 22, 2025 •

edited

Loading

lolbinarycat left a comment •

edited

Loading