Skip to content

bbh_michigan_monthly: state the measured ~825 KB transfer in the docstring - #104

Merged
mmcky merged 3 commits into
mainfrom
bbh-michigan-docstring-figure
Aug 19, 2026
Merged

bbh_michigan_monthly: state the measured ~825 KB transfer in the docstring#104
mmcky merged 3 commits into
mainfrom
bbh-michigan-docstring-figure

Conversation

@mmcky

@mmcky mmcky commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

The instrumented run in the #96 validation measured 824,944 bytes total (1 API GET of 4,181 B plus 6 range requests totalling 820,763 B) against the docstring's "~310 KiB". The range-reading claim and byte-for-byte reproduction both verified; the gap is the 256 KiB buffer each of the three members is read through, so the docstring now states the measured transfer and why it overshoots the compressed member bytes. Documentation-only — no behavior change.

Closes #97

🤖 Generated with Claude Code

…tring

The #96 validation instrumented the builder's HTTP traffic: 1 API GET
(4,181 B) plus 6 range requests totalling 820,763 B = 824,944 bytes,
~2.6x the docstring's "~310 KiB". The builder is genuinely range-based
(no full-archive fallback ran); the gap is the 256 KiB read buffer each
member is streamed through. Documentation-only.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings August 18, 2026 23:04

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the bbh_michigan_monthly builder’s module docstring to reflect the measured HTTP transfer size observed during validation (#96/#97), clarifying why the transfer exceeds the compressed member sizes while keeping builder behavior unchanged.

Changes:

  • Revise the “Network cost” docstring section to report the measured ~825 KB transfer and attribute the overshoot to buffered range reads.
  • Preserve the existing claim that the builder uses HTTP Range requests with a full-download fallback.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread builders/bbh_michigan_monthly.py Outdated
mmcky and others added 2 commits August 19, 2026 13:26
Copilot review: the paragraph states the deposit in IEC units (189 MiB,
256 KiB, ~310 KiB) but the measured transfer was added as decimal
"~825 KB". Exact bytes (824,944) sidestep the unit mix and match the
instrumented figure in the #96 validation record verbatim.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@mmcky
mmcky merged commit 6336111 into main Aug 19, 2026
1 check passed
@mmcky
mmcky deleted the bbh-michigan-docstring-figure branch August 19, 2026 03:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bbh_michigan_monthly.py docstring understates its network transfer (~310 KiB claimed, ~825 KB measured)

2 participants