Minor: Update JoinHashMap comment example to make it clearer #8154
Conversation
This file contains 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
github-actions
bot
removed
the
documentation
alamb
commented
Nov 13, 2023
| @@ -61,44 +61,45 @@ use hashbrown::HashSet; | |||
| /// | |||
| /// ``` text | |||
| /// See the example below: | |||
| /// Insert (1,1) | |||
| /// | |||
| /// Insert (10,1) <-- insert hash value 10 with row index 1 | |||
There was a problem hiding this comment.
I found the overloaded use of 1 as both a hash value and an index VERY confusing. Therefore I propose to use different values for the hash value and the index values
Dandandan
approved these changes
Nov 14, 2023
alamb
changed the title
Dandandan
approved these changes
Nov 14, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Which issue does this PR close?
Part of #8130
Rationale for this change
While working on #8130 I am reading the code carefully, and I want to encode my knowledge into comments
What changes are included in this PR?
Update some example documentation to make it clearer what is going on
Are these changes tested?
Exisitng tets
Are there any user-facing changes?
No, just comments