search

Devanshshah1309 / pe

0 stars 0 forks source link

Unclear instructions on expelling students from group #17

Open Devanshshah1309 opened 2 years ago

Devanshshah1309 commented 2 years ago

Not clear what i is referring to here since it is not used in the command at all.

Screenshot 2022-11-11 at 5.25.15 PM.png

If I don't understand the command properly, I would be scared to execute it (given that "expelling a student" is properly an important command).

Not just a cosmetic bug - it impairs usability.

nus-se-bot commented 2 years ago

Team's Response

the component is shown clearly in the command format

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I still don't understand what i is here.

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: Note: &lt; and &gt; are used to refer to < and > respectively.

Is i the same as &lt; index &gt;? If so, why are there 2 different notations used?

It's an inconsistency with the command format and the description, so not just a cosmetic bug. As mentioned in the original comment, it impairs usability because as a user, I don't know what i is referring to.

It makes it harder to understand because the "i" is not written as i (cosmetic issue - which is not the main focus of this issue but makes matters worse).

The correct way to write the description would be:

Removes the student at index &lt; index &gt; from the group &lt; groupName &gt;.

Since you're using groupName correctly, I think it was an oversight to use i instead of &lt; index &gt;