nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Session date constaint is not specified in the documentation #652

Open nus-pe-bot opened 6 days ago

nus-pe-bot commented 6 days ago

When trying to add a session date, the constraint that the session date needs to be in the format 'dd MMM yyyy' is not specified anywhere in the documentation, this leads to end users being confused as to the format of the session date, and would have to input a invalid date to find out when shown the error message shown below

Screenshot 2024-11-15 at 4.17.47 PM.png

To recreate

  1. Run the application

  2. Enter the command add_session s/Test Session d/12/11/23 p/1 m/1 into the command box

  3. See error message which shows that the session must be in the format dd MMM yyy, with a given example

Expected Behavior

The expected behavior is that the user documentation for the add_session command should inform the user that the session date must be in the format dd MMM yyy and that dd yyy are numerical while MMM follows the first 3 letters of the month

Actual Behavior

As shown in the screenshot below, the constraint on date is not specified on the user documentation

Screenshot 2024-11-15 at 4.20.43 PM.png

Proposed Improvment

For a better and more information user documentation, add a section in the user documentation which states that the constraint on the session date is that it has to follow the fomat dd MMM yyy and that the dd and yyyy sections are numerical and MMM follows the first 3 letters of the month


[original: nus-cs2103-AY2425S1/pe-interim#927] [original labels: severity.Medium type.DocumentationBug]

keithxun commented 5 days ago

Team's Response

image.png

As shown in our UG example commands and screenshot, it shows the correct format for the date. Moreover, the date format is shown in the error message when user enters an invalid date format.

However, we do note that we should have stated explicitly the format in the UG and will be classifying it as a low severity bug.

Duplicate status (if any):

--