Skip to content

Commit f4ab3fc

Browse files
bgraingerRon Petrusha
authored andcommitted
Update documentation to match code comments. (#2545)
1 parent bad8c12 commit f4ab3fc

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

xml/System.Buffers/ReadOnlySequence`1.xml

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -460,8 +460,8 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
460460
</Parameters>
461461
<Docs>
462462
<param name="start">The start index at which to begin this slice.</param>
463-
<summary>Forms a slice out of the current <see cref="T:System.Buffers.ReadOnlySequence`1" /> , beginning at a specified index and continuing to the end of the read-only sequence.</summary>
464-
<returns>To be added.</returns>
463+
<summary>Forms a slice out of the current <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at a specified index and continuing to the end of the read-only sequence.</summary>
464+
<returns>A slice starting at index <paramref name="start" /> and continuing to the end of the current read-only sequence.</returns>
465465
<remarks>To be added.</remarks>
466466
</Docs>
467467
</Member>
@@ -491,8 +491,8 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
491491
</Parameters>
492492
<Docs>
493493
<param name="start">The starting (inclusive) <see cref="T:System.SequencePosition" /> at which to begin this slice.</param>
494-
<summary>Forms a slice out of the current <see cref="T:System.Buffers.ReadOnlySequence`1" /> that begins at a specified starting sequence position and continues to its end.</summary>
495-
<returns>To be added.</returns>
494+
<summary>Forms a slice out of the current <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at a specified sequence position and continuing to the end of the read-only sequence.</summary>
495+
<returns>A slice starting at sequence position <paramref name="start" /> and continuing to the end of the current read-only sequence.</returns>
496496
<remarks>To be added.</remarks>
497497
</Docs>
498498
</Member>
@@ -523,8 +523,8 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
523523
</Parameters>
524524
<Docs>
525525
<param name="start">The index at which to begin this slice.</param>
526-
<param name="length">The length of the slice</param>
527-
<summary>Forms a slice out of the given <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at <paramref name="start" />, with <paramref name="length" /> items.</summary>
526+
<param name="length">The length of the slice.</param>
527+
<summary>Forms a slice out of the current <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at <paramref name="start" />, with <paramref name="length" /> items.</summary>
528528
<returns>A slice that consists of <paramref name="length" /> elements from the current instance starting at index <paramref name="start" />.</returns>
529529
<remarks>To be added.</remarks>
530530
</Docs>
@@ -556,9 +556,9 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
556556
</Parameters>
557557
<Docs>
558558
<param name="start">The index at which to begin this slice.</param>
559-
<param name="end">The end (inclusive) of the slice.</param>
560-
<summary>Forms a slice out of the given <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at <paramref name="start" />, ending at <paramref name="end" /> (inclusive).</summary>
561-
<returns>A slice that consists of items from the <paramref name="start" /> sequence position to the <paramref name="end" /> sequence position in the current read-only sequence.</returns>
559+
<param name="end">The end (exclusive) <see cref="T:System.SequencePosition" /> of the slice.</param>
560+
<summary>Forms a slice out of the current <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at <paramref name="start" /> and ending at <paramref name="end" /> (exclusive).</summary>
561+
<returns>A slice that consists of items from the <paramref name="start" /> index to, but not including, the <paramref name="end" /> sequence position in the current read-only sequence.</returns>
562562
<remarks>To be added.</remarks>
563563
</Docs>
564564
</Member>
@@ -591,7 +591,7 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
591591
<param name="start">The index at which to begin this slice.</param>
592592
<param name="length">The length of the slice.</param>
593593
<summary>Forms a slice out of the given <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at <paramref name="start" />, with <paramref name="length" /> items.</summary>
594-
<returns>To be added.</returns>
594+
<returns>A slice that consists of <paramref name="length" /> elements from the current instance starting at index <paramref name="start" />.</returns>
595595
<remarks>To be added.</remarks>
596596
</Docs>
597597
</Member>
@@ -622,9 +622,9 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
622622
</Parameters>
623623
<Docs>
624624
<param name="start">The index at which to begin this slice.</param>
625-
<param name="end">The end (inclusive) of the slice.</param>
626-
<summary>Forms a slice out of the given <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at <paramref name="start" />, ending at <paramref name="end" /> (inclusive).</summary>
627-
<returns>To be added.</returns>
625+
<param name="end">The end (exclusive) of the slice.</param>
626+
<summary>Forms a slice out of the current <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at <paramref name="start" /> and ending at <paramref name="end" /> (exclusive).</summary>
627+
<returns>A slice that consists of items from the <paramref name="start" /> index to, but not including, the <paramref name="end" /> sequence position in the current read-only sequence.</returns>
628628
<remarks>To be added.</remarks>
629629
</Docs>
630630
</Member>
@@ -656,8 +656,8 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
656656
<Docs>
657657
<param name="start">The starting (inclusive) <see cref="T:System.SequencePosition" /> at which to begin this slice.</param>
658658
<param name="length">The length of the slice.</param>
659-
<summary>Forms a slice out of the given <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at '<paramref name="start" />, with <paramref name="length" /> items.</summary>
660-
<returns>To be added.</returns>
659+
<summary>Forms a slice out of the current <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at <paramref name="start" />, with <paramref name="length" /> items.</summary>
660+
<returns>A slice that consists of <paramref name="length" /> elements from the current instance starting at sequence position <paramref name="start" />.</returns>
661661
<remarks>To be added.</remarks>
662662
</Docs>
663663
</Member>
@@ -689,8 +689,8 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
689689
<Docs>
690690
<param name="start">The starting (inclusive) <see cref="T:System.SequencePosition" /> at which to begin this slice.</param>
691691
<param name="length">The length of the slice.</param>
692-
<summary>Forms a slice out of the given <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at <paramref name="start" />, with <paramref name="length" /> items.</summary>
693-
<returns>To be added.</returns>
692+
<summary>Forms a slice out of the current <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at <paramref name="start" />, with <paramref name="length" /> items.</summary>
693+
<returns>A slice that consists of <paramref name="length" /> elements from the current instance starting at sequence position <paramref name="start" />.</returns>
694694
<remarks>To be added.</remarks>
695695
</Docs>
696696
</Member>
@@ -721,9 +721,9 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
721721
</Parameters>
722722
<Docs>
723723
<param name="start">The starting (inclusive) <see cref="T:System.SequencePosition" /> at which to begin this slice.</param>
724-
<param name="end">The ending (inclusive) <see cref="T:System.SequencePosition" /> of the slice.</param>
725-
<summary>Forms a slice out of the given <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at <paramref name="start" />, ending at <paramref name="end" /> (inclusive).</summary>
726-
<returns>To be added.</returns>
724+
<param name="end">The ending (exclusive) <see cref="T:System.SequencePosition" /> of the slice.</param>
725+
<summary>Forms a slice out of the current <see cref="T:System.Buffers.ReadOnlySequence`1" />, beginning at <paramref name="start" /> and ending at <paramref name="end" /> (exclusive).</summary>
726+
<returns>A slice that consists of items from the <paramref name="start" /> sequence position to, but not including, the <paramref name="end" /> sequence position in the current read-only sequence.</returns>
727727
<remarks>To be added.</remarks>
728728
</Docs>
729729
</Member>

0 commit comments

Comments
 (0)