Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Project HashMap: Improve requirement clarity #29013

Merged
merged 7 commits into from
Nov 11, 2024

Conversation

cyphersept
Copy link
Contributor

Because

  • This PR aims to improve clarity of the assignment instructions for Project: HashMap by decreasing wordiness and making implicit requirements explicit, so that students can more easily understand the complex project standards

This PR

  • Added variables for load factor and capacity to explicit requirements
  • Clarified expected behaviour for bucket growth
  • Added link to previous lesson's section on collision handling referenced in the assignment
  • Clarified expected outcomes in testing section
  • Made terminology more consistent with itself and with previous lesson: "capacity" is now used only to describe the number of buckets in the hash map, "load levels" and "fullness" used only to describe what fraction of the HashMap's capacity is actually filled, and "load factor" is used for the maximum allowed load level before the buckets are grown.
  • Some verbose sentences rewritten
  • Some vague descriptions expanded
  • Verbal "fluff" removed in lengthy sections
  • Minor grammatical fixes

Issue

Related to #27682

Additional Information

Discord username: @phosphorflux

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project curriculum contributing guide
  • The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • If this PR addresses an open issue, it is linked in the Issue section
  • If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
  • If any lesson files are included in this PR, they follow the Layout Style Guide

@github-actions github-actions bot added the Content: JavaScript Involves the JavaScript course label Oct 28, 2024
@cyphersept cyphersept changed the title Update project_hash_map.md Project HashMap: Improve requirement clarity Oct 28, 2024
Copy link
Contributor

@JoshDevHub JoshDevHub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work. Looks mostly good, just have one small nit and one small thing to discuss before I approve/merge. Let me know what you think.

javascript/computer_science/project_hash_map.md Outdated Show resolved Hide resolved
javascript/computer_science/project_hash_map.md Outdated Show resolved Hide resolved
Copy link
Contributor

@JoshDevHub JoshDevHub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work. Just one more small change to get the Markdown linter to pass, and then I'll be good to merge.

Another thing: the Ruby course has this exact same project in it just with example code written in the Ruby language. Would you be comfortable making a new PR that makes these updates there as well? You shouldn't have to know any Ruby to do this, and if you had any questions, I'd be glad to help.

javascript/computer_science/project_hash_map.md Outdated Show resolved Hide resolved
@cyphersept
Copy link
Contributor Author

@JoshDevHub thanks for the catch, I fixed the linter issue. I went ahead and made the changes to the Ruby lesson on the newest commit after the lint fix because I think it makes more sense to keep the changes synced in the same PR. If you'd rather I open a new PR, please let me know.

Copy link
Contributor

@JoshDevHub JoshDevHub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, looking good. And it's fine to have the Ruby stuff in this PR as well.

Just a couple small changes related to differences in Ruby and JS, but after those are good to go, I'll be glad to merge.

Thank you for making these changes. I think they make the project a lot better 🥇

ruby/computer_science/project_hash_map.md Outdated Show resolved Hide resolved
ruby/computer_science/project_hash_map.md Outdated Show resolved Hide resolved
cyphersept and others added 2 commits November 6, 2024 17:49
Co-authored-by: Josh Smith <jmsmith1018@gmail.com>
Co-authored-by: Josh Smith <jmsmith1018@gmail.com>
Copy link
Contributor

@JoshDevHub JoshDevHub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. Thank you so much for putting in the work on this.

@JoshDevHub JoshDevHub merged commit 5ec2e64 into TheOdinProject:main Nov 11, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content: JavaScript Involves the JavaScript course
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants