chore: fix inaccurate comment for MergeWithPlurality function #5362
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.
Type of change
Description
The comment for the MergeWithPlurality function in merge.go has been corrected to accurately reflect its functionality. The previous comment incorrectly named the function as "EnsurePlurality" and did not properly describe what the function does.
The updated comment clarifies that this function merges contained and containing ComparablePrincipalSets while satisfying plurality requirements, which provides a clearer understanding of its purpose and behavior.
Additional details
Related issues