-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added detailed documentation for Stream.Read(Span<byte>) method. #10469
base: main
Are you sure you want to change the base?
Conversation
- Included exception documentation for IOException, NotSupportedException, and ObjectDisposedException. - Expanded remarks section to explain method behavior, including position handling and buffer usage. - Removed redundant MemberSignature and ReturnValue blocks to streamline the structure. - Preserved all relevant assembly and parameter information for framework compatibility.
@jisaiaha please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ), 1. Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, “Project” means any of the projects owned or managed by .NET Foundation and offered under a license “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any “Submission” means the Code and any other copyrightable material Submitted by You, including any 2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any 3. Originality of Work. You represent that each of Your Submissions is entirely Your 4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else 5. Licenses. a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. 6. Representations and Warranties. You represent that You are legally entitled to grant the above 7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or 8. Information about Submissions. You agree that contributions to Projects and information about 9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and 10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and .NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1. |
Tagging subscribers to this area: @dotnet/area-system-io |
Learn Build status updates of commit 82551fc:
|
File | Status | Preview URL | Details |
---|---|---|---|
xml/System.IO/Stream.xml | View | Details |
xml/System.IO/Stream.xml
- Line 0, Column 0: [Warning: ECMA2Yaml_CrefTypePrefixMissing]
Invalid cref format (System.IO.IOException) detected in C:\LocalRun\W\3is5-s\xml\System.IO\Stream.xml
- Line 0, Column 0: [Warning: ECMA2Yaml_CrefTypePrefixMissing]
Invalid cref format (System.NotSupportedException) detected in C:\LocalRun\W\3is5-s\xml\System.IO\Stream.xml
- Line 0, Column 0: [Warning: ECMA2Yaml_CrefTypePrefixMissing]
Invalid cref format (System.ObjectDisposedException) detected in C:\LocalRun\W\3is5-s\xml\System.IO\Stream.xml
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
This pull request enhances the documentation for the
Stream.Read(Span<byte>)
method. The following improvements have been made:IOException
,NotSupportedException
, andObjectDisposedException
to ensure that developers are aware of the possible errors this method might throw.MemberSignature
andReturnValue
blocks to improve readability and maintain a clean, concise structure.