amzhy / pe

0 stars 0 forks source link

Restrictions on date time format is not clear enough #14

Open amzhy opened 3 years ago

amzhy commented 3 years ago

image.png

The time and date had many restrictions such as hours between 0-23 and mins between 0-59 etc. Other formats are also accepted in the app - single digit for day or month, this is not shown in the UG, but only in the app. Such important restrictions should be mentioned especially when there are many cases to consider for time.

nus-pe-bot commented 3 years ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

No mention of the date of birth format

image.png

There is no mention as to how the DOB should be formatted. There are many different formats for dates and a mention as to how this app requires the format would be useful to the user. While the user can find the way to input through the Examples:, it would still be better and clearer to explicitly state the required format.


[original: nus-cs2103-AY2122S1/pe-interim#3485] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

It is clearly implied in the example how the date of birth should be formatted. Having the date of birth here ensures that the UG is brief and the intended message is delivered.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]


:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The valid format for dates and time should be explicitly stated in the command description because there are many ways the user can interpret the inputs for date and time.

The required formats for other fields such as date and time is not covered, but it clearly explains the restrictions for other fields - duration in the description above. The restrictions for date and time are only explained after the user has entered an incorrect date/time in the app.

For example, when testing the app I was able to input single digits for days/months, but the guide implies that the format requires 2 digits for day and month - this is not covered in the examples or in the description.

The display window shows the various restrictions for date and time only after the user has entered an incorrect date/time. I think the user should be informed clearly of the correct formats beforehand in the user guide - to prevent such errors. It is also not user-friendly to mention that the Hour must be between a-b and minutes between c-d, which can be explained more concisely as just 24-hour format.

image.png

image.png


:question: Issue severity

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

Reason for disagreement: I think this is not severity.VeryLow bug - it is not a cosmetic issue due to typos or formatting etc.

The user guide fails to explain what are considered valid date and time inputs.

Such restrictions for date and time are conveyed to the user only in the app after the user has entered an incorrect date/time in the command.