Fix incorrect docstring on List.EnsureCapacity - #95956
Merged
Merged
Conversation
|
Tagging subscribers to this area: @dotnet/area-system-collections Issue DetailsThe current docstring is false. The new capacity is computed as "twice the current capacity, and if that's still not enough, the user-specified capacity", as demonstrated in net8.0.100:
|
This was referenced Dec 13, 2023
Member
|
This fix should be ported to official docs at https://github.com/dotnet/dotnet-api-docs/blob/c13606c90f809a9f04ca31db11d9701c696240f1/xml/System.Collections.Generic/List%601.xml#L1498-L1499 Also, do other collections have the same problem? E.g. https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.stack-1.ensurecapacity?view=net-7.0#definition |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The current docstring is false. The new capacity is computed as "twice the current capacity, and if that's still not enough, the user-specified capacity", as demonstrated in net8.0.100: