Docs truth sweep from the package audit (PR C)#27
Merged
Conversation
- Demo notebook summary matched to its own committed measurement (>125 dB / 126.4 dB, was >130 dB) - the one place the repo overstated. - Quality headline refreshed to post-C3 measured reality (135/120/112 dB), resolving the README's 16 kHz within-1-dB self-contradiction; test threshold comments updated to match. - Pico/M33 cycle claims hedged: instruction counts stated as budgets pending real-silicon CYCCNT validation, with both flashable harnesses linked from README, PERFORMANCE.md and HARDWARE_TESTING.md. - Stale-after-PR numbers: COMPARISON.md 5,206->5,043 (~9.5x->~9.8x), 8-channel ratio qualifier, Hexagon landscape figure labeled kernel-only, latency cell aligned to the designed 24 frames; M33 added to every "what is gated" sentence; PERFORMANCE.md hypothesis list annotated with C1/C2/C4/C6 outcomes; pico2_cyccnt 19x comment corrected to the 3.8x it actually describes. - HARDWARE_TESTING needs-list rewritten as exists/remains; README gains the hardware-examples tour and a consumption/versioning statement (add_subdirectory/FetchContent only, 0.1.0, pre-1.0 API caveat) plus the comparison notebook's Python deps. - alsa_bridge now applies the documented unlock-threshold guidance for its block size (compiles clean). Verified: notebook JSON valid; all relative doc links resolve; ICOUNT regen no-diff; suite subset + alsa_bridge build green. https://claude.ai/code/session_01HuAFfoeD5a5Xe5aGNA16M9
The static-musl Hexagon toolchain cannot propagate C++ exceptions: the hardened validated() throws correctly but EXPECT_THROW never catches and libc++abi terminates - surfaced by the first throw-test ever to reach that CI leg (from PR #25, so main is currently red there; this commit heals it). Validation is target-independent and covered on every other platform. Limitation recorded in the Known-debt ledger with the deployment implication (invalid Config is fatal on this toolchain; validate before constructing) and the candidate fix (-unwindlib=libunwind). https://claude.ai/code/session_01HuAFfoeD5a5Xe5aGNA16M9
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Audit fix series, part C — the documentation truth sweep. With #25 (core) and #26 (infra) merged, this closes out all audit findings.
The High
Accuracy refresh
examples/pico2_cyccnt/andexamples/pico2_dualcore/linked from every place the claim appears (README, PERFORMANCE.md, HARDWARE_TESTING.md).9.5×→9.8×), the 8-channel ratio qualifier (2.1×, outside the quoted mono/stereo range), Hexagon landscape figure labeled kernel-only with the full-converter figure alongside, latency cell aligned to the designed 24 frames; M33 added to every "what's gated" sentence; PERFORMANCE.md hypothesis list annotated with what C1/C2/C4/C6 actually shipped; the pico2_cyccnt "19×" comment corrected to the 3.8× it describes.DX gaps from the audit
srt_version()probe).samplerate,soxr) documented.alsa_bridgenow applies the documented unlock-threshold-vs-block-size guidance instead of contradicting it.Verified: notebook JSON valid, all relative doc links resolve, ICOUNT regen produces no diff, affected tests + alsa_bridge build green.
https://claude.ai/code/session_01HuAFfoeD5a5Xe5aGNA16M9
Generated by Claude Code