tlx02 / pe

0 stars 0 forks source link

Message for opencom is not suitabe #5

Open tlx02 opened 2 years ago

tlx02 commented 2 years ago

Steps to reproduce: type "opencom"

Actual:

Screenshot 2022-11-11 at 4.44.48 PM.png

Expected: the message shows the description of the opencom format, which does not seem to make sense. I think showing a message to say that we have moved to the commission tab is better and more intuitive.

soc-se-bot commented 2 years ago

Team's Response

Hi,

Thank you for your bug report. Unfortunately, we'll be rejecting this bug report as this is a feature, not a bug of ArtBuddy.

If you will, allow me to explain our reasoning behind this design decision.

As you know, ArtBuddy has 2 usages of the opencom command: opencom (without an index), and opencom INDEX (with an index). We realised that this can be a source of confusion for new users. Take for instance the case where a new user tries out the command opencom without an index. He may not realise that it is also possible to perform opencom with an index.

As such, to rectify this, we decided that it'd be a better to show the command format for opencom each time it is being executed so that users are also aware that usage of opencom INDEX is also possible. If you're interested, this is the exact PR where this exact change was deliberately made: https://github.com/AY2223S1-CS2103T-W11-3/tp/pull/160.

With this...


With the above justification, I hope you can also see why this bug is not a type.FunctionalityBug (expected behavior). A suggestion to change the error message is a type.FeatureFlaw anyways, according to:

Specificity of error message: Error messages can be correct but not specific enough (e.g., it says the input is 'invalid' without giving the reason, or gives too many possible reasons without pointing out the specific reason). These cases can be considered type.FeatureFlaw.

Nevertheless, I hope that my explanation above helped you in understanding why this behaviour is intended, and this issue is being rejected by our team. Thanks!

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]


:question: Issue type

Team chose [type.FeatureFlaw] Originally [type.FunctionalityBug]

Reason for disagreement: [replace this with your explanation]