Hash Map Lesson: Make use of terms more consistent #29008
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
JoshDevHub
requested changes
Nov 11, 2024
| @@ -98,7 +98,7 @@ This is an oversimplified explanation; we'll discuss more internal mechanics lat | |||
|
|
|||
| Now if we wanted to get a value using a key: | |||
|
|
|||
| 1. To retrieve the value, we hash the key and calculate its bucket number. | |||
| 1. To retrieve the value, we hash the key and calculate its bucket's index. | |||
There was a problem hiding this comment.
Suggested change
| 1. To retrieve the value, we hash the key and calculate its bucket's index. | |
| 1. To retrieve the value, we hash the key and calculate the index of its bucket. |
This wording is a bit more clear to me.
| @@ -168,17 +168,17 @@ For example, if we are to find the bucket where the value `"Manon"` will land, t | |||
|
|
|||
| As we continue to add nodes into our buckets, collisions get more and more likely. Eventually, however, there will be more nodes than there are buckets, which guarantees a collision (check the additional resources section for an explanation of this fact if you're curious). | |||
|
|
|||
| Remember we don't want collisions. In a perfect world each bucket will either have 0 or 1 node only, so we grow our buckets to have more chance that our nodes will spread and not stack up in the same buckets. To grow our buckets, we create a new buckets list that is double the size of the old buckets list, then we copy all nodes over to the new buckets. | |||
| Remember we don't want collisions. In a perfect world, each bucket will either have 0 or 1 node only, so we grow our hash table to have more chance that our nodes will spread and not stack up in the same buckets. To grow our hash table, we create a new one that is double its size and then copy all existing nodes over to the buckets of this new table, hashing their keys again. | |||
There was a problem hiding this comment.
I see what you're going for and why you think the current wording is a problem, but I think changing to hash table is also potentially confusing. Learners might interpret that to mean they need to create an entirely new HashMap instance and copy entries over to it somehow.
What if you called it "buckets array" in this section? This should make clear it's the containing array that needs to be changing rather than anything about individual buckets. Let me know what you think.
There was a problem hiding this comment.
Thank you for the feedback. I'll make the proposed changes. Sorry for the delay!
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.
Because
The hash map lesson refers to some terms as being different things each time. For instance, in one line it's said that we have to "grow the buckets", when in reality what we grow is the array, or the hash table. I thought it would be welcome to correct these instances so they're consistent.
This PR
Issue
Closes #XXXXX
Additional Information
Discord message where a student is confused about how it's currently written.
Pull Request Requirements
location of change: brief description of changeformat, e.g.Intro to HTML and CSS lesson: Fix link textBecausesection summarizes the reason for this PRThis PRsection has a bullet point list describing the changes in this PRIssuesection