This PR only contains documentation related changes:
XML documentation for Option.sequenceResult added.
The documentation for both Option.traverseResult and Option.sequenceResult has been moved under the Option section instead of the List subsection of ResultOption. The reasons are:
The collection Option.traverseResult operates on is an option, not a result option, and it does not operate on a list.
Option.sequenceResult operates on an option result (i.e., Option<Result<T, E>>), not a result option.
Some minor changes to the tutorial code for Option.traverseResult refer to so that the tutorial examples compile.
Types of changes
What types of changes does your code introduce to FsToolkit.ErrorHandling?
[x] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
Checklist
[x] Build and tests pass locally
[ ] I have added tests that prove my fix is effective or that my feature works (if appropriate)
[ ] I have added necessary documentation (if appropriate)
Proposed Changes
This PR only contains documentation related changes:
Option.sequenceResultadded.Option.traverseResultandOption.sequenceResulthas been moved under the Option section instead of the List subsection of ResultOption. The reasons are:Option.traverseResultoperates on is an option, not a result option, and it does not operate on a list.Option.sequenceResultoperates on an option result (i.e.,Option<Result<T, E>>), not a result option.Option.traverseResultrefer to so that the tutorial examples compile.Types of changes
What types of changes does your code introduce to FsToolkit.ErrorHandling?
Checklist