Update returns documentation for StringBuilder comparison#12275
Open
mahfeshar wants to merge 1 commit intodotnet:mainfrom
Open
Update returns documentation for StringBuilder comparison#12275mahfeshar wants to merge 1 commit intodotnet:mainfrom
mahfeshar wants to merge 1 commit intodotnet:mainfrom
Conversation
github-actions
bot
added
the
needs-area-label
dotnet-policy-service
bot
added
the
community-contribution
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This update corrects the documentation for the StringBuilder.Equals(StringBuilder) method to align with the actual behavior in modern .NET versions (.NET Core 3.0 and later).
Identified Issues:
Incorrect Returns Description: The section currently states that Capacity and MaxCapacity are compared. This is legacy behavior from .NET Framework and no longer applies to modern .NET, where only the string content is compared.
Outdated Example Output: The code example's expected output incorrectly shows False when comparing two StringBuilder objects with different capacities but identical content. In modern .NET, this returns True.
Internal Contradiction: The "Remarks" section correctly mentions the change in .NET Core 3.0, but the "Returns" and "Example" sections were never updated, leading to developer confusion.
Proposed Changes:
Refine : Updated the text to focus on character equality rather than memory capacity.
Update Snippet Output: Adjusted the sample output (case b4) from False to True to match the results when running on modern .NET runtimes.