fix dotnet/corefx#36798 by updating PipeReader doc comment (dotnet/corefx#37919)
authorAndrew Stanton-Nurse <andrew@stanton-nurse.com>
Fri, 24 May 2019 13:50:01 +0000 (06:50 -0700)
committerStephen Toub <stoub@microsoft.com>
Fri, 24 May 2019 13:50:01 +0000 (09:50 -0400)
Fixes dotnet/corefx#36798

Corrects an inaccurate doc comment in System.IO.Pipelines.PipeReader

Commit migrated from https://github.com/dotnet/corefx/commit/cbc9701436853421b389e118e410e7470c887353

src/libraries/System.IO.Pipelines/src/System/IO/Pipelines/PipeReader.cs

index fafa50b..beb2e14 100644 (file)
@@ -71,7 +71,7 @@ namespace System.IO.Pipelines
         public abstract void Complete(Exception exception = null);
 
         /// <summary>
-        /// Cancel the pending <see cref="ReadAsync"/> operation. If there is none, cancels next <see cref="ReadAsync"/> operation, without completing the <see cref="PipeWriter"/>.
+        /// Registers a callback that gets executed when the <see cref="PipeWriter"/> side of the pipe is completed
         /// </summary>
         public abstract void OnWriterCompleted(Action<Exception, object> callback, object state);