Added Comments to Each of the Solutions #2
Conversation
This file contains hidden or 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
Standardized grammar in DieRoll solution
Fixed a few grammar and spelling mistakes in comments, formatted comments to be in keeping with the rest of the code (line breaks and extra, empty comment lines).
03LoopedGuessingGame/src/solution.js
Outdated
Collaborator
There was a problem hiding this comment.
I think you might want to be clearer here, since it's a little ambiguous whether you're checking the equality or asserting it. What I think you mean is that this line sets the variable num to be equal to the value returned by rollDie(). Just make sure you're explicit. Compare:
// *checks* whether num is equal to the value of rollDie()
num == rollDie();to
// sets num equal to the value of rollDie()
num = rollDie();
Owner
|
Can you edit your comments so that that do NOT restate implementation details (e.g., "uses parseInt", "sets the variable authorsName", etc), but instead focus on explaining the meaning of the code. In other words, tell me what the code means .... not what it does ... because the code itself tells me what it does. |
Adds a little bit of clarification to comments in 02, 03, 04, and 05.
Owner
|
Has there been any progress on this? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Our group went through an added line comments for each of the solution files to the problems. We thought that this would help people who looked at the solution files understand what was going on through each step, and make the solutions more beneficial for somebody who is having a hard time understanding what is going on.