Skip to content

Fix documentation for ReadOnlySequence.GetOffset #11755

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Sep 22, 2025
Merged

Fix documentation for ReadOnlySequence.GetOffset #11755

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af54749
Fix documentation for ReadOnlySequence.GetOffset
jeffhandley Sep 1, 2025
448a89a
Update xml/System.Buffers/ReadOnlySequence`1.xml
gewarren Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions xml/System.Buffers/ReadOnlySequence`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,9 +463,9 @@
</Parameters>
<Docs>
<param name="position">The <see cref="T:System.SequencePosition" /> of which to get the offset.</param>
<summary>Returns the offset of a <paramref name="position" /> within this sequence from the start.</summary>
<returns>The offset from the start of the sequence.</returns>
<remarks>To be added.</remarks>
<summary>Returns the offset of a <paramref name="position" /> within this sequence.</summary>
<returns>The offset in the sequence.</returns>
<remarks>The returned offset is not a zero-based index from the start. To obtain the zero-based index offset, subtract <code>mySequence.GetOffset(mySequence.Start)</code> from the returned offset.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The position is out of range.</exception>
</Docs>
</Member>
Expand Down