search

Rachelcoll / pe

0 stars 0 forks source link

`mark` allows extra user input without warning #9

Open Rachelcoll opened 1 week ago

Rachelcoll commented 1 week ago

Currently mark marks all students' attendance, but input things like mark 1 won't throw and error or warning to user. Users may input mark 1 thinking it only marks attendance of first student but marks all students. It's quite difficult for user to remember ug all the time.

Suggestion: execute command, or display a warning message please notice mark command will mark all students if user inputs an index

soc-pe-bot commented 1 week ago

Team's Response

image.png

We mentioned earlier in the UG that extra parameters for certain commands that don't accept parameters will be ignored. About the functionality of mark 1 marking the first index's student, we've also already mentioned implementing this under Planned Enhancement 2 in our DG.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: There seems to be some misunderstanding of my issue. While UG does mention that extra parameters for commands that don't accept them will be ignored, this notice is placed far from the mark command section and doesn't specifically mention mark. This increases the likelihood of user confusion when mistakenly inputting something like mark 1, under the impression that it only marks the first student's attendance. It is very inconvenient for user to find this note far from mark command in UG and do self-inference that this notice is mentioning mark command when they just need to mark an attendance. So it is still a necessary function needed for your app under current status.

Also, please note that this issue is an independent issue from the planned enhancement of adding a mark INDEX feature. Adding a warning when the mark command receives extra input would help mitigate user confusion based on the current behavior and provide immediate user feedback without conflicting with the existing UG. Implementing this warning would guide users who might not frequently refer to the UG, helping them understand that mark currently affects all students.

## :question: Issue type Team chose [`type.DocumentationBug`] Originally [`type.FeatureFlaw`] - [x] I disagree **Reason for disagreement:** This issue is suggesting adding warning in terminal when user is adding extra input for a command, which should be considered as `FeatureFlaw` since it is a design flaw that could be enhanced to increase user convenience.