Clarify reasons UnorderedMap::insert can fail #782
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 sentence in the page for UnorderedMap seems to imply that the only reason
insert(key)might fail is because the capacity is exceeded. A user could then think that an empty map with capacity N can always have N unique keys inserted without failures, but this actually does fail often in practice.Near the bottom, the breakdown of UnorderedMapInsertResult does explain this but I think it's useful to say it at the top too.