Align NetworkStream.Read Remarks with src inline documentation. #1930
Conversation
This file contains 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
|
@ViktorHofer, |
mairaw
approved these changes
Apr 17, 2017
There was a problem hiding this comment.
LGTM. Thanks @ViktorHofer! Wondering if we wanna add that info to the returns tag similar to what we have in the source code, so it can show up in IntelliSense as well.
|
@mairaw you are welcome. Yeah I thought the same. I will add it. |
|
@mairaw do you need anything else from me? Otherwise I will go into sleep mode here ;) |
|
No, I don't. Thanks @ViktorHofer. I need to investigate why the build is still processing though. |
|
Builds are finally green! 🎆 |
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
NetworkStream.Read remarks could be misleading and should align with inline corefx documentation.
Related
Fixes #1929
corefx inline documentation: https://github.com/dotnet/corefx/blob/master/src/System.Net.Sockets/src/System/Net/Sockets/NetworkStream.cs#L262
cc: @karelz