johnrhimawan / pe

0 stars 0 forks source link

Incorrect notation for month and minute #13

Open johnrhimawan opened 1 year ago

johnrhimawan commented 1 year ago

image.png

This date time format displayed uses the same notation for both month and minute, as a reader it would be difficult to distinguish between the two.

nus-se-script commented 1 year ago

Team's Response

Understandable, but there is an example right after the notations to clear up any misunderstandings. We feel that its common sense that hh:mm means hours and minutes, not hours and months.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Just because there is an example present, it does not make this correct. This is still a documentation bug as the user guide is not adhering to the official standard for the pattern of date and time. Month needs to be represented as MM, not mm. If the argument is that everything can be cleared up by examples, then what is the use of displaying a format in the first place. The format is used to guide users on how to use the application correctly, and as such it should provide information that does not mislead the user.

Moreover, the group does seem to be aware that it should be MM instead of mm since they used the correct notation in another portion of the user guide:

image.png

The group also used the correct notation in the application itself which contradicts the user guide:

image.png

Such inconsistencies in formatting might hinder the reader and make the user guide less easily understood.