Fix documentation for ReadOnlySequence.GetOffset #116524
Open
+6
−2
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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the XML documentation for ReadOnlySequence.GetOffset to clarify that its returned offset is not zero-indexed.
- Removed explicit reference to “from the start” in the summary.
- Added a remarks section explaining how to adjust the offset to obtain a zero-indexed value.
Comments suppressed due to low confidence (1)
src/libraries/System.Memory/src/System/Buffers/ReadOnlySequence.cs:533
- The updated remarks clarify the non-zero indexing behavior; however, consider explicitly stating the indexing base or mentioning that this behavior is consistent with related APIs to avoid any ambiguity.
/// The returned offset is not zero indexed from the start.
github-actions
bot
added
the
needs-area-label
dotnet-policy-service
bot
added
the
community-contribution
This was referenced Jun 11, 2025
Open
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.
Fixes documentation for ReadOnlySequence.GetOffset to communicate that the returned value is not zero indexed.
Maybe this needs to be changed in https://github.com/dotnet/dotnet-api-docs too?
Related to #75866