Skip to content

Commit af54749

Browse files
committed
Fix documentation for ReadOnlySequence.GetOffset
1 parent 59d0db1 commit af54749

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

xml/System.Buffers/ReadOnlySequence`1.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -463,9 +463,9 @@
463463
</Parameters>
464464
<Docs>
465465
<param name="position">The <see cref="T:System.SequencePosition" /> of which to get the offset.</param>
466-
<summary>Returns the offset of a <paramref name="position" /> within this sequence from the start.</summary>
467-
<returns>The offset from the start of the sequence.</returns>
468-
<remarks>To be added.</remarks>
466+
<summary>Returns the offset of a <paramref name="position" /> within this sequence.</summary>
467+
<returns>The offset in the sequence.</returns>
468+
<remarks>The returned offset is not a zero-based index from the start. Subtract <code>mySequence.GetOffset(mySequence.Start)</code> from the returned offset to obtain the zero-based index offset.</remarks>
469469
<exception cref="T:System.ArgumentOutOfRangeException">The position is out of range.</exception>
470470
</Docs>
471471
</Member>

0 commit comments

Comments
 (0)