Commit 4023e14
committed
docs(ldm): align staleness check wording + scope docs.rs feature set
Three doc/metadata corrections across the LDM surface:
1. `bt::BtMatcher::prepare_ldm_candidates` (bt/mod.rs:354) and
`ldm::LdmProducer::generate_into` (ldm/mod.rs:167, plus the
regression-test doc at ldm/mod.rs:589) all described the
staleness check as `entry.offset <= history_abs_start`. The
actual implementation since commit e1932b2 is an inclusive
lower bound: `find_best_match` rejects entries with
`match_abs < lowest_index_abs` so entries at exactly
`lowest_index_abs == history_abs_start` survive. Updated
the three doc sites to describe the inclusive filter,
pointing at `ldm::search::FindBestMatchInputs::lowest_index_abs`
for the canonical definition.
2. `[package.metadata.docs.rs] all-features = true` would also
enable `rustc-dep-of-std` (libstd-build-only — swaps in
`rustc-std-workspace-*` core/alloc), `bench_internals`
(widens the public API for benches), and `fuzz_exports`
(widens it for fuzz targets). None of those should appear
on docs.rs. Replaced with explicit `features = ["std",
"hash", "dict_builder"]` so the published documentation
covers exactly the public surface.
472 / 472 lib tests pass under default features AND
`--no-default-features`. 11 / 11 doctests pass. `cargo doc
--lib --features dict_builder,std,hash` builds without
warnings. `cargo clippy --lib --tests -- -D warnings` clean
in both feature configs.1 parent 0777817 commit 4023e14
3 files changed
Lines changed: 23 additions & 12 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
20 | | - | |
21 | | - | |
22 | | - | |
23 | | - | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
24 | 30 | | |
25 | | - | |
| 31 | + | |
26 | 32 | | |
27 | 33 | | |
28 | 34 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
351 | 351 | | |
352 | 352 | | |
353 | 353 | | |
354 | | - | |
355 | | - | |
| 354 | + | |
| 355 | + | |
| 356 | + | |
| 357 | + | |
356 | 358 | | |
357 | 359 | | |
358 | 360 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
164 | 164 | | |
165 | 165 | | |
166 | 166 | | |
167 | | - | |
168 | | - | |
169 | | - | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
170 | 171 | | |
171 | 172 | | |
172 | 173 | | |
| |||
586 | 587 | | |
587 | 588 | | |
588 | 589 | | |
589 | | - | |
590 | | - | |
| 590 | + | |
| 591 | + | |
| 592 | + | |
| 593 | + | |
591 | 594 | | |
592 | 595 | | |
593 | 596 | | |
| |||
0 commit comments