yihuididi / pe

0 stars 0 forks source link

Inconsistency in user guide commands #3

Open yihuididi opened 2 weeks ago

yihuididi commented 2 weeks ago

In the attached screenshots below, there is inconsistencies between update and delete command, where delete has further split its section into deleting by INDEX and deleting by NRIC, while update did not split its section into updating by INDEX and updating by NRIC. This inconsistency may make the reader question the difference in the two commands.

Screenshot 2024-11-15 at 4.42.19 PM.png

Screenshot 2024-11-15 at 4.42.25 PM.png

Screenshot 2024-11-15 at 4.42.28 PM.png

nus-se-bot commented 1 week ago

Team's Response

We think that there is no formatting error and having both formats do not hinder the user.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: As it is a simple case of inconsistency in the user guide, I strongly believe that if given the time, the team will correct this inconsistency in the user guide. In which case, the developers should have chosen NotInScope over Rejected.

Screenshot 2024-11-19 at 12.01.01 PM.png