nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-22 14:55:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation for internal doctest API

Browse Source
This commit is contained in:
Guillaume Gomez 2024-07-09 14:24:04 +02:00
parent baf8ce83b8
commit c9f730e223
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/librustdoc/doctest.rs
View File

@ -456,6 +456,10 @@ impl RunnableDocTest {
}
}
/// Execute a `RunnableDoctest`.
///
/// This is the function that calculates the compiler command line, invokes the compiler, then
/// invokes the test or tests in a separate executable (if applicable).
fn run_test(
doctest: RunnableDocTest,
rustdoc_options: &RustdocOptions,
@ -705,6 +709,15 @@ impl IndividualTestOptions {
}
/// A doctest scraped from the code, ready to be turned into a runnable test.
///
/// The pipeline goes: [`clean`] AST -> `ScrapedDoctest` -> [`RunnableDoctest`].
/// [`run_merged_tests`] converts a bunch of scraped doctests to a single runnable doctest,
/// while [`generate_unique_doctest`] does the standalones.
///
/// [`clean`]: crate::clean
/// [`RunnableDoctest`]: crate::doctest::RunnableDoctest
/// [`run_merged_tests`]: crate::doctest::runner::DocTestRunner::run_merged_tests
/// [`generate_unique_doctest`]: crate::doctest::make::DocTestBuilder::generate_unique_doctest
pub(crate) struct ScrapedDocTest {
filename: FileName,
line: usize,