Hey everyone! I have been reading the grade-school description and thought it could use some love and a grammar check. Below are the proposed changes. The changes are purely stylistic and don’t alter the content of the description.
Given students’ names along with the grade
thatthey are in, create a roster for the school.In the end, you should be able to:
Add a student’s name to the roster for a grade:
“Add Jim to grade 2.”
“OK.”Get a list of all students enrolled in a grade:
“Which students are in grade 2?”
“We’ve only got Jimjustright now.”Get a sorted list of all students in all grades. Grades should
sortbe sorted as 1, 2, 3, etc., and students within a grade should be sorted alphabetically by name.
“Whoallis enrolled in school right now?”
“Let me think. We have Anna, Barb, and Charlie in grade 1, Alex, Peter, and Zoe in grade 2 and Jim in grade 5. So the answer is: Anna, Barb, Charlie, Alex, Peter, Zoe, and Jim.”Note that all our students only have one name (It’s a small town, what do you want?) and each student cannot be added more than once to a grade or the roster.
In fact, whenIf a test attempts to add the same student more than once, your implementation should indicate that this is incorrect.
Here’s the list of proposed changes:
-
“that they are in” ➔ “they are in”
- Simplified to improve readability.
-
“for a grade” ➔ “for a grade:”
- Added a colon at the end of the line for consistency with list formatting.
-
“just now” ➔ “right now”
- Replaced “just now” with “right now” for clearer, more natural phrasing.
-
“Grades should sort as 1, 2, 3, etc.” ➔ “Grades should be sorted as 1, 2, 3, etc.”
- Added “be sorted” for correct grammatical structure.
-
“Who all is enrolled in school right now?” ➔ “Who is enrolled in school right now?”
- Removed “all,” which is unnecessary here, to improve clarity and grammar (This is the one that made me take a closer look at the whole description in the first place. I’m very open to alternative phrasing for this)
-
“and Jim in grade 5. So the answer is: Anna, Barb, Charlie, Alex, Peter, Zoe and Jim” ➔ “and Jim in grade 5. So the answer is: Anna, Barb, Charlie, Alex, Peter, Zoe, and Jim.”
- Added “and” before Jim in the list for correct punctuation, and added a period at the end.
-
“added more than once to a grade or the roster” ➔ “added more than once to a grade or the roster.”
- Added a period at the end for completeness.
-
“In fact, when a test attempts to add the same student more than once, your implementation should indicate that this is incorrect.” ➔ “If a test attempts to add the same student more than once, your implementation should indicate that this is incorrect.”
- Replaced “when” with “if” for smoother and more conditional phrasing.
Let me know what you think about these changes!