Fix documentation for ReadOnlySequence.GetOffset #11755
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
needs-area-label
jeffhandley
added
area-System.Memory
and removed
needs-area-label
|
Tagging subscribers to this area: @dotnet/area-system-memory |
gewarren
reviewed
Sep 2, 2025
gewarren
approved these changes
Sep 2, 2025
| <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. Subtract <code>mySequence.GetOffset(mySequence.Start)</code> from the returned offset to obtain the zero-based index offset.</remarks> |
There was a problem hiding this comment.
Suggested change
| <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> | |
| <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> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Corresponding docs change for dotnet/runtime#116524