search

jiaxinnns / pe

0 stars 0 forks source link

Inconsistent command formats #16

Open jiaxinnns opened 2 weeks ago

jiaxinnns commented 2 weeks ago

Some commands require @ before the prefixes but some dont even though the commands seem similar (like delAppt VS delMedCon)

nus-se-bot commented 1 week ago

Team's Response

Hi, thank you for raising this point. However, it seems that the issue is not clearly articulated. The commands mentioned, delAppt and delMedCon, serve different purposes within the application — one for deleting appointments and the other for deleting medical conditions. Each command is designed with its own specific context, parameters and functionality, hence the differences in format.

Items for the Tester to Verify

:question: Issue response

Team chose [response.IssueUnclear]

Reason for disagreement: I understand that the commands serve different purposes (that's why they are different commands), but they all perform the same 'category' of actions, which is to delete something from a patient's data. Both have different parameters as expected, but they have already been differentiated using the letter directly before the / (like t, d, etc. not the @ symbol). The @ symbol does not differentiate or clarify any of the parameters.

For example, most, if not all, CLIs such as the Github CLI utliise the same prefix standard throughout all the commands, for example all flags are prefixed with - (-b, -p). Changing, for example, the checkout -b command to become checkout @b would be inconsistent even though the -b and -p flags serve different purposes.

If the team had intended to use different prefixes like @ for different command groups, delAllergy, del and delMedCon should also have different command formats (eg. use #al/ for allergy VS &c/ for conditions) since they also serve different purposes -- one for deleting allergies, one for deleting patient entries, and one for deleting medical conditions.