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
//FOR FEATURE-GATED LOGIC:
//
// /// # [Method/Trait Name]
// ///
// /// Brief description.
// ///
// /// ## Feature Dependencies
// ///
// /// - `associated_type_defaults`: [why needed]
// /// - `impl_trait_in_assoc_type`: [why needed]
// ///
// /// ## Compiler Parallel
// ///
// /// Similar pattern in `rustc_module::Type` ([link/line]).
// ///
// /// ## Why This Design
// ///
// /// [The decision context that would otherwise leave]
// ///
// /// ## Without This
// ///
// /// [What breaks or becomes painful]
//
//
// FOR COMPLEX FLOWS:
//
// /// # [Flow Name]
// ///
// /// Brief description.
// ///
// /// ## Flow
// ///
// /// ```text
// /// Input → Step 1 → Step 2 → Output
// /// ↓
// /// [condition] → Alternate path
// /// ```
// ///
// /// ## Decision Points
// ///
// /// 1. [Condition]: [Why this branch]
// /// 2. [Condition]: [Why this branch]
// ///
// /// ## Failure Modes
// ///
// /// - [Failure]: [Glass state] → [Recovery]
//
//
// FOR STONED-ME REMINDERS:
//
// // ═══════════════════════════════════════════════
// // STONED-ME NOTE:
// // This looks weird but it's because [reason].
// // Don't "fix" this without reading [other file].
// // The fuckiness is intentional: [why].
// // ═══════════════════════════════════════════════