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

Bug - Exercisehash_exercises.rb:favorite_list should be renamed to favorite_hash #96

Open
3 tasks done
sometimescasey opened this issue Dec 29, 2023 · 0 comments · May be fixed by #97
Open
3 tasks done

Bug - Exercisehash_exercises.rb:favorite_list should be renamed to favorite_hash #96

sometimescasey opened this issue Dec 29, 2023 · 0 comments · May be fixed by #97
Labels
Status: Needs Review This issue/PR needs an initial or additional review Type: Bug Involves something that isn't working as intended

Comments

@sometimescasey
Copy link

sometimescasey commented Dec 29, 2023

Complete the following REQUIRED checkboxes:

  • I have thoroughly read and understand The Odin Project Contributing Guide
  • The title of this issue follows the Bug - location of bug: brief description of bug format, e.g. Bug - Exercises: File type incorrect for all test files

The following checkbox is OPTIONAL:

  • I would like to be assigned this issue to work on it

1. Description of the Bug:

Using the parameter name favorite_hash instead of favorite_list would leave the least amount of room for ambiguity.

It's not obvious that favorite_list is meant to be a hash, as opposed to a list of hashes.

It's also unclear because the first method to be implemented is called create_favorite_hash(), not create_favorite_list().

Everything was clear once I checked hash_exercises_spec.rb. But from the perspective of someone who is brand new to programming and doesn't necessarily understand how to read a test file, this may not be obvious.

(I do recognize that this is more of an opinion than a bug, as someone who is more familiar with Python and thinks of arrays as lists, and hashes as dictionaries.)

2. How To Reproduce:

Open ruby_basics/7_hashes/exercises/hash_exercises.rb.

3. Expected Behavior:

I would have expected the method argument to be named favorite_hash if the expected input is to be a hash.

4. Desktop/Device: N/A for this bug, but ok :)

  • Device: Macbook Pro
  • OS: Ventura
  • Browser: Chrome
  • Version:

5. Additional Information:

@sometimescasey sometimescasey added Status: Needs Review This issue/PR needs an initial or additional review Type: Bug Involves something that isn't working as intended labels Dec 29, 2023
@sometimescasey sometimescasey changed the title Bug - Exercisehash_exercises.rb:favourite_list should be renamed to favorite_hash Bug - Exercisehash_exercises.rb:favorite_list should be renamed to favorite_hash Dec 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Needs Review This issue/PR needs an initial or additional review Type: Bug Involves something that isn't working as intended
Projects
None yet
1 participant