From 733f147e16e100ba27bff53d2927945b33f0a665 Mon Sep 17 00:00:00 2001
From: carlossanlop <calope@microsoft.com>
Date: Tue, 17 Dec 2019 14:49:51 -0800
Subject: [PATCH] Automatically port System.IO.Pipelines.PipeReader remarks

---
 xml/System.IO.Pipelines/PipeReader.xml | 28 ++++++++++++++++++++++++--
 1 file changed, 26 insertions(+), 2 deletions(-)

diff --git a/xml/System.IO.Pipelines/PipeReader.xml b/xml/System.IO.Pipelines/PipeReader.xml
index b15640d4fd6..943c3209f74 100644
--- a/xml/System.IO.Pipelines/PipeReader.xml
+++ b/xml/System.IO.Pipelines/PipeReader.xml
@@ -85,7 +85,19 @@ The memory for the consumed data will be released and no longer available. The <
       <Docs>
         <param name="consumed">Marks the extent of the data that has been successfully processed.</param>
         <summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed.</summary>
-        <remarks>To be added.</remarks>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+The memory for the consumed data will be released and no longer available.
+
+The <xref:System.IO.Pipelines.ReadResult.Buffer> previously returned from <xref:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)> must not be accessed after this call.
+
+The examined data communicates to the pipeline when it should signal more data is available.
+
+          ]]></format>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="AdvanceTo">
@@ -114,7 +126,19 @@ The memory for the consumed data will be released and no longer available. The <
         <param name="consumed">Marks the extent of the data that has been successfully processed.</param>
         <param name="examined">Marks the extent of the data that has been read and examined.</param>
         <summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed, read and examined.</summary>
-        <remarks>To be added.</remarks>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+The memory for the consumed data will be released and no longer available.
+
+The <xref:System.IO.Pipelines.ReadResult.Buffer> previously returned from <xref:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)> must not be accessed after this call.
+
+The examined data communicates to the pipeline when it should signal more data is available.
+
+          ]]></format>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="AsStream">