tlyi / pe Goto Github PK

Sometimes the shelf name is enclosed in quotation, sometimes it is not. Would be good if it was more consistent.

In the content page for the UG, "Add customer rating & review for each item" is formatted as a hyperlink but when clicked, it does not lead to anywhere.

Steps to reproduce:

1. sell id/2
2. sell id/2345566

Expected:
If i'm not wrong, these commands are invalid because the item id is not 8 digits right? So the user should be shown something along those lines where item id is invalid/not found.

Actual:
A lot of unnecessary information.

Steps to reproduce:

1. Input delete command with negative index

Expected:
Error message saying index number cannot be negative

Actual:
Error message saying command format is invalid, but not mentioned anywhere that index number cannot be negative (though it is stated in the UG, it should probably be mentioned in the app as well)

Under "Search for item" in UG, this example command was supposed to be search k/cover instead.

Not sure if it was intended but the warehouse shelf is automatically created.
Perhaps it would be a good idea to tell the user about that in the UG, as now it seems like it was unintentionally left inside the app.

Steps to reproduce:

1. Create shelf with name " Potato"
2. Delete shelf with name " Potato"

Expected:
Able to delete " Potato", since the message tells me that shelf with " Potato" has been created.

Actual:
Shelf with name " Potato" cannot be found.

Edit: Realised that " Potato" was created as "Potato", so I could delete it by deleting "Potato". However, I think the message Shelf " Potato" has been created is very misleading, since the name here includes the leading whitespace.

Since the PROPERTY values (e.g purchase cost) for the edit command are crucial and pre-defined values, it should have been included in the command summary as well.

Perhaps it would have been better if the difference between index and ID was explained from the beginning. Was quite confused at the start.

Steps to reproduce:

1. Try the delete command with a very big number as the index, e.g 3294324947324373

Expected:
Error message as item with index 3294324947324373 is not found.

Actual: Error message that seems unintentional and does not provide any information:

These 2 diagrams have almost the same logic, except for the final execute() command. It seems unnecessary to include both. Perhaps for the second diagram, all the things related to parsing could have been hidden/replaced with a ref frame to the first diagram instead, so that the reader does not lose focus on the main point of the diagram.

Especially for commands where multiple parameters are accepted, it is hard to tell which parameter I provided wrongly, since the error messages are the same every time (invalid format).

E.g: add command

First error: Selling price negative number

Second error: Quantity parameter missing

In both cases, same error message is shown; not very helpful to the user.

There should be activation bars for the object newMessage when addMessage() and printMessage() is called.

Steps to reproduce:

1. Create shelf "Book2"
2. add n/Discounted Book shlv/Book2 p/27 s/37 q/5 r/

Expected:
Command to succeed as remark can be empty anyways

Actual:
Error message for invalid format, but error message is not very tailored to this case.

No details provided by bug reporter.

Not sure if this was intended but all the messages seem to be pushed to the right. This made the viewing experience less pleasant.

Steps to reproduce:

1. Use the sell command with a very large id, e.g 2234344837

Expected: Error message saying item does not exist

Actual: Error message saying command format is wrong

The sequence diagrams contains a lot of information but they were not explained properly. Some of the methods in the sequence diagram is not trivial, and more details could have been provided to explain the logic.

Steps to reproduce:

1. Use get command with a very large number as index, e.g 1232827474934

Expected:
Error message, item does not exist

Actual:

Inaccurate and seemingly unintentional error message.

E.g: delete was shown before list. At this point, I still did not know how to retrieve the index of the item.