docs(changelog): document Deadline() and RetryOptions.Timeout() - #252
Merged
Conversation
…cumented Deadline(TimeSpan) (whole-run wall-clock bound) and RetryOptions.Timeout(TimeSpan) (per-attempt read timeout) both landed in this Unreleased cycle but never got an Added entry — the changelog only referenced 'configured Deadline' in passing, from the exception added later, so a reader had no way to learn either feature exists.
|
|
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
1 participant
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
Two public APIs shipped in this
Unreleasedcycle never got anAddedentry:ReportBuilder<T>.Deadline(TimeSpan)— the opt-in wall-clock bound on the whole run (rec feat(abstractions): XML docs completos e build multi-target #5).RetryOptions.Timeout(TimeSpan)— the opt-in per-attempt read timeout (WP6).The changelog mentioned "configured
Deadline" only in passing, inside theReportDeadlineExceededExceptionentry added later — so a reader had no way to discover either feature exists. For an OSS library about to cut a release, that's a real gap: these are the two knobs that stop a report from hanging on a slow source, and both are off by default, so nobody enables what they don't know about.Both descriptions were checked against the APIs' own XML docs (cooperative cancellation, honoured by the async ADO/HTTP/Mongo reads).
Docs only — no code change.