Repository navigation
Docs: the AsyncReads() how-to, with the measured reasons and four figures - #166
Merged
Merged
Conversation
…se it, with the measured costs) A new guide page, "Row reads: sync by default, AsyncReads() to opt in": the default stated plainly, where a thread waits (figure), the measured reasons for the sync default (CPU, memory, wall time on a real link), and a dedicated AsyncReads() section: what it does, when to use it, what it costs, the busy-pool hazard and the large-value warning for Map(Func). Every number is labeled with its run and "one run"; the thread-pool benefit, the busy pool on a real link and Map(Func) on a 100 MB value are marked UNMEASURED. Four SVGs (light and dark), a compiled side-by-side sample (AsyncReads.cs) with new sample checks, one sentence and link in the mapping article, and one line in the table of contents. Docs only: no Source, Tests or PublicAPI change. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…oll sideways on a phone Each of the four SVGs now paints a solid background card (the same --bg/--frame variables as the performance charts), so it stays readable when the site theme and the OS color scheme differ. Data bars are solid fills in the family colors with rounded ends and no outline. In the article each figure sits in an overflow-x container with a 600 px minimum width, so text never drops below 13 px at phone width. Docs only. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
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
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.
What this changes
Adds the page that explains
AsyncReads(): why it exists, what it does, what it costs and when to use it. Until now only the release notes mentioned it. Docs and samples only: noSource/, tests or public API change.The page (
docsite/articles/async-reads.md) states the default plainly (rows are read with a synchronous read, even on an async call, andAsyncReads()opts a single call intoReadAsync), shows the two side by side with equal-height code regions, and gives the reasons with their numbers:Map(Func)and none forMap<T>(), and the link-time case, each from a measured run and cited by run label, scenario, provider and "one run";IDataReaderchecks the token on every row under an async terminal.Four figures (flow, cost, large value, link time) are standalone SVGs that follow the OS colour scheme like the architecture figure; each was checked in light and dark, with bars to scale.
Samples.
docsite/samples/AsyncReads.csholds six compiled regions, run by the samples program ("All 140 sample checks passed.", 134 on master, 6 new, none removed). All examples are async with a real token,staticwhere nothing is captured, one call per line,=>on the next line, and within 80 columns.toc.ymland one sentence inmapping.mdlink the page.Nine files in all: the page, four SVGs, the sample,
toc.yml,mapping.mdandProgram.cs.Checks
🤖 Generated with Claude Code