Clarify Enumerable.Prepend returns a new sequence #11900
+1
−1
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.
Summary
Enumerable.Prepend<TSource>
summary to clarify it returns a new sequenceDetails
The
Enumerable.Prepend<TSource>
method had a confusing summary that stated "Adds a value to the beginning of thesequence." This wording incorrectly implied that the method modifies the original sequence in place.
The Problem
The original summary was misleading because:
While the Remarks section included a note clarifying "This method does not modify the elements of the collection.
Instead, it creates a copy of the collection with the new element," the summary itself was still confusing and
contradictory.
Changes Made
Updated the summary from:
To:
Why This Matters
This clarification helps developers:
Prepend
follows LINQ's immutability patternAppend
,Select
,Where
, etc. are documentedThe new wording is consistent with the Returns section which already correctly stated "A new sequence that begins
with element."
Fixes #11745