rickkoh / pe

0 stars 0 forks source link

Wrong error message for the command `export` #4

Open rickkoh opened 7 months ago

rickkoh commented 7 months ago

Description

image.png The error in the app says to make sure that export.csv is not opened. I have ensured that export.csv is not opened. Upon further inspection in the UserGuide, I found out that the export command did not work because I did not create a folder named export in the app's directory. However, the error message shown in the application says otherwise.

Steps to reproduce

  1. Ensure that the application is a "freshly" opened application.
  2. Input the command export.
  3. Wait for the error message to show up.

Expected Behaviour

Error message should prompt the user to create a folder named export in the app's directory just as how the UserGuide had described.

Actual

Application says Something went wrong! Make sure export.csv is not open! instead.

Possible Enhancement

Can possibly auto create the export folder for users.

Notes

Severity is medium as if the user does not know how to navigate the UserGuide (which is quite common for users to not read the guide), they may never know how to use the export feature.

nus-se-bot commented 7 months ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

wrong error displayed when using the export command.

steps to reproduce

  1. input export

expected

exports the persons stored in the application.

actual

displays the error: Something went wrong! Make sure export.csv is not open!

however, I do not have any file named export.csv opened at the moment in my device.

screenshots

Screenshot 2024-04-19 at 4.52.30 PM.png


[original: nus-cs2103-AY2324S2/pe-interim#4399] [original labels: type.FunctionalityBug severity.Medium]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

It is likely that this error is due to the lack of an export file in the directory. It is hard to tell since there is no context given, but during our testing this was the case every time. There is a section to address this in the UG, which specifies creating an export file when using the command. There is also a description of todos and a warning to emphasise this:

image.png

Since it is expected that users would take note of this warning, I believe the error message is not incorrect, since the app is being used in a scenario that it is not meant to be used in. Should the export file have been created, it is likely that this error message would only pop up in appropriate scenarios.

However, if there are any further issues, or missing context that prove otherwise, do follow up on this!

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]


## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** Hi, thank you for taking the time to address this issue. I understand that there is a workaround, which is to create an `export` folder beforehand. However, the issue we are reporting pertains to the error message displayed. I believe that if, for example, the inability to export the data file is caused by not creating the `export` folder, then the program should display an error message prompting the user to create the `export` folder. Having an incorrect error message could potentially inconvenience the user and lead them to spend time debugging in the wrong direction, only to realise that creating the `export` folder was the solution. Furthermore, as you mentioned, 'Should the export file have been created, it is likely that this error message would only pop up in appropriate scenarios.' I would argue that if the export file has not been created, the program should display the correct error message accordingly.
## :question: Issue type Team chose [`type.FunctionalityBug`] Originally [`type.FeatureFlaw`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]