kewenlok / pe Goto Github PK

There are multiple instance where the structure of error message displayed sounds confusing. Not sure whether it is intended style the application adopt but isn't it better to display it in a way that could be easily understand by the user?

Steps to reproduce

1. Run the application.
2. Load the delivery data using start command.
3. Type in one of the three commands below:
   i. view w
   ii. complete 2, 3, 4
   iii. complete 1

Expected
The structure of the sentence should be easily understandble.

Actual

Should the loading of delivery data to be done automatically when the application started instead of requiring the users to do it manually?

The descriptions in under most feature implementation is redundant as it essentially repeats the points and flow which are shown in the sequence diagram of each section. Having too many words might appear to be unappealing to developers who want to get a quick grasp of the team's product and it is much better to show the sequence diagram only. If the team would like to include description, consider summarising it and talk about the details which are not shown on the diagram.

One example of Implementation Description and Sequence diagram

The record feature does not show the completed deliveries when the application restarted.

Steps to reproduce

1. Run the application
2. Type the start command.
3. Mark any of the available deliveries as complete.
4. Type record command. You will see the normal behaviour here.
5. Exit the program.
6. Repeat step 1-2.
7. Run record command again.

Expected

Actual

The application crashed when trying to load deliveries data into list under the situation where the max weight is negative value.

Steps to reproduce

1. Run the application.
2. Edit the current profile using the editprofile command.
3. Exit the program.
4. Edit the last field of the data/profile.txt into -11 and save it.
5. Run the application.
6. Run start command.
7. You will see an error as shown in the actual section below being thrown and the application crashed.

Expected
Error message telling the user that the deliveries matching the max weight is not found.

Actual

There are two different sample of usages for the "editprofile" command but only one expected output for it. This may cause confusion to inexperience user as there are no tags or footer indicating which command does the output belongs to. It would be better if some kind of footer or description is included for clarity purpose.

As mentioned in class by Prof Akshay, the footer for the PlantUML sequence diagram must be hidden or else it will be considered as a bug. There are multiple sequence diagram in the DG which violates this rule as shown below.

The application crashes when max weight modified in the profile.txt is invalid (eg. 99999999999999999999999999 or hello) due to lack of file input validation. As one of the requirements for tp is to allow users to edit data in the data file, it is crucial for developer to implement input validation and sanitisation for the data loaded from file or at least handle it in such a way that the application will not crash.

Steps to reproduce

1. Run the application.
2. Edit the current profile using the editprofile command.
3. Exit the program.
4. Edit the last field of the data/profile.txt into 99999999999999999999999999 and save it.
5. Run the application.
6. You will see an error as shown in the actual section below being thrown and the application crashed.

Expected

1. Display an error message to user to inform them that the value is out of range and prompt them to enter the correct value.

Actual

There are multiple occurrences where the application name is not standardised. The two most common application name shown in the UG and DG are Diliveri and Deliveri. It will make unfamiliar users to be confused by the title while using the guides.

The command summary section of the UG appears to be cluttered and unorganised as it is all written in one sentence without clear segregation as shown in the diagram below. Is it better to place it in a table so that it appears more appealing and clean to the user?