Clarify usage patterns and Outcome composition#121
Draft
Reefact wants to merge 10 commits into
Draft
Conversation
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.
Summary
This PR separates usage decisions from the detailed
OutcomeAPI so readers can first choose the right error-propagation pattern, then learn fluent composition without mixing both concerns. It also clarifies howErrorContextremains attached to an error across outcomes, exceptions, and inner-error composition.Type of change
Changes
Outcome,Outcome<T>,Then,To,Recover,Finally, exception escape hatches, and asynchronous composition.ErrorContextguides with clear role boundaries, transport-independent propagation, data-safety guidance, and a practical checklist.Outcome<T>results throughGetResultOrThrow()rather than a non-existentValueproperty.Testing
dotnet build FirstClassErrors.slndotnet test FirstClassErrors.slnFirstClassErrors.Analyzers.UnitTests)No build or test command was run because this PR changes Markdown documentation only. The examples were checked against the current
Outcome,Outcome<T>, port-error, and context APIs, and the branch diff and cross-page navigation were reviewed manually.Documentation
doc/updateddoc/README.fr.md) updated if user-facing behavior changedThe French counterpart of every changed or added English page is included.
doc/README.fr.mditself did not require a change becauseUsagePatterns.fr.mdremains the existing entry point and now links to the dedicated Outcome guide.Related issues
None.