Week 3: HW01 Review

 I reviewed 3 of my classmate's HW01: Mariah Stinson, Justin Martlock, and Cody Hopkins. 

Below are my notes for each:

Mariah

Mariah's code is clear and easy to follow. All methods work as intended and her logic does not need to be changed. Her use of JavaDoc documentation is detailed and clearly states what each method does. I only see one warning which is that private boolean debug = false; is redundant. When I remove "=false" code works just as good. All unit tests pass.

Justin

Justin's code is clear and easy to understand. All variable names are appropriate and his use of JavaDoc documentation is good. All unit tests pass. No need to change any logic as every method works as intended. The only warning I see is that debug is being initialized as false and then set to false again in the nonparameterized Hangman() constructor.

Cody

Cody's code is clear and concise with appropriately named variables and good use of logic. I do not see any warnings or errors in his code. When running the test classes, I was able to pass all but testDisplayGameState()

Reviews for my code:

Claudia has clear and concise variable names with proper formatting. No logic that could be changed that improves what is already written. No unused imports or warnings. Each method has extensive JavaDoc documentation. Every unit test passed.

1. What improvements would you make to your code/what was suggested? 
• I wasn't suggested any changes, but I definitely approached this very literally, as in I didn't do anything special to create any methods, I just followed the prompt as is.
2. Which unit tests were the hardest to pass?
• For me, the hardest test to pass was testDisplayGameState(). It took me a long time to figure out why my output was failing.
3. How do the existing tests function and could they be improved?
   1. Do the existing unit tests cover the full range of the sub classes?
   • Yes, they do. I believe that me and all my classmates codes didn't have any warnings about unused methods or anything like that because the tests utilized everything.
   2. How would you change the unit tests?
   • I don't believe there are any unit tests I would change. I did have trouble with testDisplayGameState(), due to it being very specific about what output it needed but I wouldn't say change it just because *I* couldn't pass it for a bit.
4. What did you struggle with?
1.  I struggle with Strings and understanding how to approach a failing unit test. Once I see that a test fails, I find myself not coding with intention and just start throwing code at the problem. This doesn't help me learn, it just helps me "pass." 
5. What did one of your teammates struggle with?
1. One of my teammates appeared to struggle with the same unit test that I did.
6. Was any part of the code a struggle for YOU?
1. For longer methods with more requirements, I would forget small things that would cause it not to work properly so I would have to go back and try to find what I was forgetting.
7. Was any part of writing the code easy for YOU?
1. If there is one thing I can do, it's iterating through a list to find an element.
8. What was your biggest HW1 victory?
1. My biggest victory was that I was able to figure out how to pass all the tests successfully.