search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Inconsistent Optional Field Representation for Filter Command #2402

Open nus-pe-bot opened 1 week ago

nus-pe-bot commented 1 week ago

Description

The User Guide specifies that the sd|START DATE parameter in the filter command is optional, enclosed in square brackets ([sd|START DATE]). However, in the application's error message, the filter usage syntax does not indicate sd|START DATE as optional, leading to confusion.

Steps to Reproduce

  1. Enter the filter command with only the sd|START DATE parameter. filter sd|2024-12-21

Expected Result

An error message that correctly indicates sd|START DATE as optional, matching the User Guide's notation.

Actual Result

Screenshot 2567-11-15 at 17.08.09.png

The error message suggests that sd|START DATE is required, displaying it without square brackets, which is inconsistent with the User Guide.

Screenshot 2567-11-15 at 17.16.21.png

Concern

This inconsistency may confuse users regarding the correct usage of optional parameters in the filter command.

[original: nus-cs2103-AY2425S1/pe-interim#3269] [original labels: severity.Low type.FunctionalityBug]

yugan01 commented 1 week ago

Team's Response

We acknowledge that the error msg is inconsistent.

Duplicate status (if any):

--