1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
// Test-only harness: not part of the public API (this whole module is
// private and additionally `#[doc(hidden)]`), never rendered by `cargo doc`,
// and irrelevant to `public-api.txt` / docs.rs. Its only job is to make
// `cargo test`'s doctest pass pick up the fenced Rust code blocks in every
// narrative guide (`docs/*.md`) and the root `README.md`, so a signature
// change that silently stops matching a guide's example fails CI instead of
// quietly lying to a reader (see task T-047).
//
// This is deliberately unrelated to `decisions/readme-crate-doc-sourcing.md`
// (which is about *not* pulling `README.md`'s prose into the rendered crate
// doc via `#![doc = include_str!(...)]` on the crate root, to avoid
// duplicating/mismatching the docs.rs landing page). Here the include lands
// on a private, hidden module purely so rustdoc's doctest extractor walks its
// fenced blocks — the text itself is never published anywhere.
//
// Gated on all six optional features, including the default
// `process-control`, so it only builds under `cargo test --all-features`
// (the guides collectively demonstrate the `process-control`/`stats`/
// `limits`/`mock`/`tracing`/`record` surfaces); the default and
// `--no-default-features` CI legs never see this module at all.
/// `README.md` (crate root) — kept **out** of the rendered crate doc
/// (see `decisions/readme-crate-doc-sourcing.md`); included here only so its
/// fenced Rust blocks run as doctests.
/// `docs/README.md` — the guide-set index.
/// `docs/commands.md`.
/// `docs/cookbook.md`.
/// `docs/streaming.md`.
/// `docs/pipelines.md`.
/// `docs/supervision.md`.
/// `docs/testing.md`.
/// `docs/timeouts-and-cancellation.md`.
/// `docs/errors.md`.
/// `docs/process-groups.md`.
/// `docs/platform-support.md`.
/// `docs/migrating-1.2-to-2.1.md`.
/// `docs/upgrading.md`.