bawfen / pe Goto Github PK

Perhaps the individual command classes could have class diagrams in their own sections, instead of showing all of them together implementing the abstract class?

When adding an item with a category that has multiple spaces, it filters correctly but is shown to the user lacking the multiple spaces.

Though the documentation states that the numerical inputs are enforced to be within 0 to 99,999,999:

It allowed a upc value of 9999999999 (9,999,999,999):

But does not allow a price value of the same magnitude

Or a quantity value

The output of the help command is slightly inconsistent when it comes to the format of parameters.
UPC here is meant to be the UPC of the items in the inventory list, but is shown without square brackets unlike the output of the remove command

Here, "cat table" and "cat list" are what the user is meant to key in.

Perhaps the number of nested blocks could be decreased by showing only the "happy" flow and not putting the opt block?

Program crashed while calling "cat list"

This is possibly due to a category with more than one space.

The system allows you to add items with prices below 0.01 (with 3 decimal places)

When calling filter, it returns the result when using the query "filter f/price p/gt 0"

While it is technically correct to return this to the user, I believe that it might be confusing as the amount shown in the result is equal to the "0" which was queried.

Perhaps it might be better to return an error when adding the item or show more decimal places in the filtered result?

The program shows that the alerts file has been corrupted even though it was empty before running a single "alert add" command.

Nothing was done to the file in between the running of the earlier commands.

Maybe the ref blocks in this sequence diagram could be opaque to improve readability?

When including an f in the price for the "filter" command, it does not return an error as expected for a non-numerical input.

An error message is included for the "add" command.

Perhaps it would be good for the handling of "f" to be consistent across both commands?

Program crashed while calling "cat table"

This is possibly due to there being a category name with multiple spaces

When adding an item with price 0.001 (less than 2 decimal places) the system accepts it.

When calling list, it is shown to the user as $0.00

Perhaps it might be better to either throw an error if the price is below 2 decimal places, or display the additional decimal places in the search result?

Should the ref block here be opaque instead to improve readability?

The alt blocks should be behind the activation bars, and the ref block could be opaque to make it easier to read.

The documentation here claims that the user calls the "run" command at startup, which instantiates the program.

However, according to the code, the static main function is the one that is called to create a new instance of the MagusStock Class, whose "run" command is then called.

Here the Command Summary states that curly brackets are for optional commands

The Add Item command has category as a mandatory parameter.

However, it is actually optional

By convention, the activation bars should be above the alt blocks (not hidden behind the alt blocks). This also makes the diagram difficult to read.