FlyingDonkeys / pe

0 stars 0 forks source link

Misleading hint for the NUS NETID parameter #9

Open FlyingDonkeys opened 1 week ago

FlyingDonkeys commented 1 week ago

In the add command, the format for NUS NETID was given to be nid/NUS_NETID as shown

image.png

but for the edit command, the format changed to nid/EMAIL.

image.png

Not purely a cosmetic feature as it actually affects the workflow of the user, as users may input e1122579@u.nus.edu instead of e1122579 for example, hence the severity of medium was assigned.

nus-pe-script commented 4 days ago

Team's Response

This was definitely an oversight on our part and it should be NUS_NETID for both. That said, we propose to lower the severity to low as the examples provided in the UG use NUS_NetID and the error message that appears if a user does enter the full email explicitly informs the user of the correct format to use, therefore only causing minor confusion to some users.

Screenshot 2024-11-17 132258.png

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]