search

GeNiaaz / pe

0 stars 0 forks source link

UG does not match command given in program #7

Open GeNiaaz opened 3 years ago

GeNiaaz commented 3 years ago

User Guide example at the bottom states that q/DATE and i/false

image.png

However, in the program, the example given q/false and i/DATE

image.png

This would be very confusing to the user.

nus-se-bot commented 3 years ago

Team's Response

Both the commands provided in the User Guide and the program are valid inputs, in terms of the inputs of infection and quarantine statuses.

image.png

As shown above, both q/ and i/ can be followed by a valid date or false.

image.png

Furthermore, the above diagram from the user guide also shows that the parameters can be given in any order.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I see now how you meant to describe it, it was instead meant to take on EITHER date or a boolean. However, it was stated that the QUARANTINE_STATUS and INFECTED_STATUS can only be false or the date of the quarantine or infection respectively. This may confuse the user as the user may understand this as the first being a boolean value and the second being a date, when it in fact is either for both values.

In light of your clarification about the implementation, I am inclined to agree with your severity downgrade, however I maintain that this while a small issue, should be fixed in your documentation to instead say "... can either be false OR the date for both entries".

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.High]

Reason for disagreement: [replace this with your explanation]