fix: correct module doc — only Pass 1 routes through handle_read_error, not Pass N

This commit is contained in:
Matthew Jackson
2026-06-23 23:34:02 -07:00
parent dc7ab01907
commit a324e5c62f
+5 -6
View File
@@ -1,11 +1,10 @@
//! Single source of truth for what to do when a sector read fails. //! Single source of truth for what to do when a sector read fails.
//! //!
//! Both Pass 1 (`Disc::sweep`) and Pass 2-N (`Disc::patch`) call into //! Pass 1 (`Disc::sweep`) calls into `handle_read_error` after every failed
//! `handle_read_error` after every failed `read_sectors`. The handler //! `read_sectors`. The handler classifies the error, updates the in-flight
//! classifies the error, updates the in-flight context (counters, //! context (counters, damage window, retry budgets), and returns a
//! damage window, retry budgets), and returns a `ReadAction` the caller //! `ReadAction` the caller dispatches on. Pass N patch has its own
//! dispatches on. Every read goes through the same gate — no path can //! `handle_read_failure` in `disc/patch.rs` that does not route here.
//! silently skip pause/skip/jump/abort logic.
//! //!
//! Adding a new error class = add one arm in `handle_read_error`. //! Adding a new error class = add one arm in `handle_read_error`.
//! Adding new logging on errors = one place. //! Adding new logging on errors = one place.