Datetime format description unclear in UG

[LimAiLin]

Description:

The datetime format description is not very clear in the User Guide. I am not really able to tell what kind of date and time formats is accepted until I look at the examples. At first glance, I am unsure if the date format is yyyy-MM-dd or yyyy-dd-MM.

Perhaps it would be better if your team make it clear, e.g. Date takes in an input of yyyy-MM-dd or MM/dd/yyyy.

I think it's a little strange for your team to put “6/4/2022” will be read as 4 June. under The following dates and times are known not to work.

In fact, it works I believe it is just that you might not have specified the format properly, leading to a lot of confusion.

Really really cool that your team used jchronic since I never heard of it! :D

Screenshots:

[nus-se-script]

Team's Response

Downgraded to Low as:

• The date format is explained right below the excerpt shown in the screenshot, so the user won't be confused for long. However, we agree that the accepted formats should be roughly explained up front.

  

• 6/4/2022 being read as 4 June is indeed a bug, as the date parsing is intended to understand the way an SoC student might write a date - D/M/Y is far likelier than M/D/Y. Labeling it a bug now prevents users from relying on it and being confused when it's fixed in the future. A tweak could help with this though, such as "known not to work properly".

Items for the Tester to Verify

❓ Issue severity

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

• I disagree

Reason for disagreement: [replace this with your explanation]

---