Improve CancelPendingRead/Flush() docs #5033
Merged
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
halter73
commented
Oct 24, 2020
|
|
||
| ## Remarks | ||
|
|
||
| The canceled <xref:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)> operation returns a <xref:System.IO.Pipelines.ReadResult> where <xref:System.IO.Pipelines.ReadResult.IsCanceled> is true. |
There was a problem hiding this comment.
How do I verify that I didn't mess up the syntax or references locally before submitting a PR?
There was a problem hiding this comment.
- Go to this PR's CI section.
- Expand the "Show all checks" link.
- Look at the OpenPublishing.Build leg - It should say "Validation status: passed". Not "warnings" or "errors".
- Click on the "Details" link.
- In the new window, scroll down to the "Validated files" table.
- For any of the files you modified in your PR, which will show up in the table, click on the "View" link under the "Preview URL" column.
- You'll be able to see your changes as they would look in MS Docs (this is just a preview site).
For this particular API, this is the preview page.
|
Docs Build status updates of commit 7f7c66b: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
|
||
| ## Remarks | ||
|
|
||
| The canceled <xref:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)> operation returns a <xref:System.IO.Pipelines.ReadResult> where <xref:System.IO.Pipelines.ReadResult.IsCanceled> is true. |
There was a problem hiding this comment.
- Go to this PR's CI section.
- Expand the "Show all checks" link.
- Look at the OpenPublishing.Build leg - It should say "Validation status: passed". Not "warnings" or "errors".
- Click on the "Details" link.
- In the new window, scroll down to the "Validated files" table.
- For any of the files you modified in your PR, which will show up in the table, click on the "View" link under the "Preview URL" column.
- You'll be able to see your changes as they would look in MS Docs (this is just a preview site).
For this particular API, this is the preview page.
Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>
|
Docs Build status updates of commit ea4f338: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
BrennanConroy
approved these changes
Oct 28, 2020
|
@carlossanlop I think this is good to go. |
carlossanlop
approved these changes
Oct 29, 2020
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
Better explain ReadResult.IsCanceled/FlushResult.IsCanceled, PipeReader.CancelPendingRead()/PipeWriter.CancelPendingFlush() and their relationship with each other.
Fixes dotnet/runtime#38739