HttpContent: Buffering is implementation dependent #10108
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
For `ReadAsStreamAsync`, corrects the documentation to indicate that waiting for the content to be buffered prior to task completion is conditional based on implementation. For `ReadAsStreamAsync` and `ReadAsStream`, gives an example of a common implementation that conditionally buffers. Per a [comment](dotnet/runtime#31316 (comment)) by @stephentoub, this area of documentation could stand improvement. This commit appears to be the first step in doing so.
ghost
added
the
dotnet-policy-service
bot
added
the
community-contribution
|
Tagging subscribers to this area: @dotnet/ncl |
This comment was marked as outdated.
This comment was marked as outdated.
gfoidl
reviewed
Jul 14, 2024
Co-authored-by: Günther Foidl <[email protected]>
Co-authored-by: Günther Foidl <[email protected]>
This comment was marked as outdated.
This comment was marked as outdated.
|
Learn Build status updates of commit 98e56cd:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| xml/System.Net.Http/HttpContent.xml | View | Details |
xml/System.Net.Http/HttpContent.xml
- Line 0, Column 0: [Warning: disallowed-html-tag - See documentation]
HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. - Line 0, Column 0: [Warning: disallowed-html-tag - See documentation]
HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. - Line 0, Column 0: [Warning: disallowed-html-tag - See documentation]
HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. - Line 0, Column 0: [Warning: disallowed-html-tag - See documentation]
HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. - Line 0, Column 0: [Warning: disallowed-html-tag - See documentation]
HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. - Line 0, Column 0: [Warning: disallowed-html-tag - See documentation]
HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
ManickaP
approved these changes
Jul 15, 2024
gewarren
reviewed
Jul 19, 2024
|
Learn Build status updates of commit a7a2535: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
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.
For
ReadAsStreamAsync, corrects the documentation to indicate that waiting for the content to be buffered prior to task completion is conditional based on implementation.For
ReadAsStreamAsyncandReadAsStream, gives an example of a common implementation that conditionally buffers.Per a comment by @stephentoub, this area of documentation could stand improvement. This commit appears to be the first step in doing so.
Summary
Describe your changes here.
Fixes #Issue_Number (if available)