Skip to content
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

Port System.IO.Pipelines source code comments to Docs #2304

Merged
merged 10 commits into from Apr 26, 2019

Conversation

@carlossanlop
Copy link
Member

commented Apr 15, 2019

Summary

Porting the source code comments I found in System.IO.Pipelines to Docs.

Fixes #Issue_Number (if available)

@carlossanlop

This comment has been minimized.

Copy link
Member Author

commented Apr 15, 2019

@mairaw please take a look whenever you get a chance.
Adding the source code owners @pakrym, @davidfowl in case you want to review the comments. I ported them with no modifications.

@rpetrusha rpetrusha added this to the April 2019 milestone Apr 16, 2019

@rpetrusha
Copy link
Contributor

left a comment

Thanks for documenting these, @carlossanlop. There were some additional members that didn't have triple-slash comments in the source; could you add the documentation for them as well? (My comments include the documentation to be added.)

Show resolved Hide resolved xml/System.IO.Pipelines/PipeReader.xml Outdated
Show resolved Hide resolved xml/System.IO.Pipelines/PipeReader.xml Outdated
Show resolved Hide resolved xml/System.IO.Pipelines/PipeReader.xml
Show resolved Hide resolved xml/System.IO.Pipelines/PipeWriter.xml
Show resolved Hide resolved xml/System.IO.Pipelines/PipeWriter.xml
Show resolved Hide resolved xml/System.IO.Pipelines/StreamPipeExtensions.xml Outdated

rpetrusha and others added some commits Apr 16, 2019

Update xml/System.IO.Pipelines/PipeReader.xml
Thank you very much for adding the missing returns value.

Co-Authored-By: carlossanlop <1175054+carlossanlop@users.noreply.github.com>
Update xml/System.IO.Pipelines/PipeReader.xml
Nice catch. Thank you for the correction.

Co-Authored-By: carlossanlop <1175054+carlossanlop@users.noreply.github.com>
Update xml/System.IO.Pipelines/StreamPipeExtensions.xml
Co-Authored-By: carlossanlop <1175054+carlossanlop@users.noreply.github.com>
@carlossanlop

This comment has been minimized.

Copy link
Member Author

commented Apr 22, 2019

The build error message says it "failed to load files". Is there anything I should do from my side?
@mairaw @rpetrusha

@mairaw

This comment has been minimized.

Copy link
Contributor

commented Apr 22, 2019

Nope @carlossanlop. A deployment happened today that it might be impacting this. I'll check.

@mairaw mairaw closed this Apr 22, 2019

@mairaw mairaw reopened this Apr 22, 2019

@mairaw mairaw closed this Apr 23, 2019

@mairaw mairaw reopened this Apr 23, 2019

@carlossanlop

This comment has been minimized.

Copy link
Member Author

commented Apr 24, 2019

Thank you @mairaw for catching that close tag. Not sure how it disappeared. I probably removed it by accident manually, I don't think it was the tool's fault.

rpetrusha added some commits Apr 25, 2019

@pakrym

pakrym approved these changes Apr 25, 2019

@rpetrusha
Copy link
Contributor

left a comment

This looks good, @carlossanlop. I'll approve now and merge when the build completes successfully.

Show resolved Hide resolved xml/System.IO.Pipelines/PipeWriter.xml
Show resolved Hide resolved xml/System.IO.Pipelines/PipeWriter.xml
@anurse

anurse approved these changes Apr 25, 2019

Show resolved Hide resolved xml/System.IO.Pipelines/PipeReader.xml Outdated
Show resolved Hide resolved xml/System.IO.Pipelines/PipeWriter.xml Outdated
Show resolved Hide resolved xml/System.IO.Pipelines/PipeWriter.xml Outdated
Show resolved Hide resolved xml/System.IO.Pipelines/PipeWriter.xml Outdated
Show resolved Hide resolved xml/System.IO.Pipelines/PipeWriter.xml Outdated
Show resolved Hide resolved xml/System.IO.Pipelines/PipeWriter.xml Outdated
@mairaw
Copy link
Contributor

left a comment

A couple of suggestions since the build has some warnings

Show resolved Hide resolved xml/System.IO.Pipelines/PipeReader.xml Outdated
Show resolved Hide resolved xml/System.IO.Pipelines/PipeWriter.xml Outdated
Show resolved Hide resolved xml/System.IO.Pipelines/PipeWriter.xml Outdated
Apply suggestions from code review
Suggestions from anurse and mairaw.

Co-Authored-By: carlossanlop <1175054+carlossanlop@users.noreply.github.com>

@rpetrusha rpetrusha merged commit da91ecf into dotnet:master Apr 26, 2019

6 checks passed

OpenPublishing.Build Validation status: passed
Details
OpenPublishing.Build (1 of 3) Waiting for processor completed at 09:14:35 PST
OpenPublishing.Build (2 of 3) Preparing completed at 09:30:56 PST
OpenPublishing.Build (3 of 3) Building completed at 09:54:32 PST
WIP Ready for review
Details
license/cla All CLA requirements met.
Details

@mairaw mairaw added this to In progress in April 2019 via automation Apr 26, 2019

@mairaw mairaw added the new-content label Apr 26, 2019

@mairaw mairaw moved this from In progress to Done in April 2019 Apr 26, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.