nus-cs2103-AY2324S2 / forum

16 stars 0 forks source link

Clarification for editing the UI display command format #803

Closed kaiyi27 closed 7 months ago

kaiyi27 commented 7 months ago

The previous code for a particular command contains of three behaviour add, edit and delete but the display command format only mention is unclear for differentiate these 3 behaviour. The command example format is also contain only for adding (missing for edit and delete).

Is it ok to fix it by adding for other 2 missing information and structure the format to make it clear for these 3 behaviour.

damithc commented 7 months ago

@kaiyi27 I need more details. Give a screenshot of the current behavior and specify the proposed new behavior (and the reason for the change).

kaiyi27 commented 7 months ago

This is the previous display of command format

Screenshot 2024-04-12 at 11 24 01 PM Screenshot 2024-04-12 at 11 24 06 PM

This is the modify version

Screenshot 2024-04-12 at 11 24 36 PM Screenshot 2024-04-12 at 11 24 42 PM

Reason for changing:

  1. The previous version is kind of unclear for the instruction and it only provide an example command format which is adding a policy. It also didnt state out properly what it stance for. In the UG, it have mentioned clearly already
  2. Adding misinformation for other action such as edit and delete to make it clear to the user, and also differentiate to 3 section to make it easier to see.
damithc commented 7 months ago

@kaiyi27 OK to add these additional info to the error message.

kaiyi27 commented 7 months ago

Ok thanks prof.