jiachen247/pe

pe's Issues

Too many digrams in UG

UG feels quite cluttered.

Fo example, isit necessary to show this set of diagram 3 times for sorting in acescending, decending as well as by deadline?

Project contains binary file padding_file

The root directory contains a binary bile padding_file

See for more info: https://nus-cs2103-ay1920s2.github.io/website/admin/tp-constraints.html#constraint-human-editable-file

Lack of examples in UG

The UG only provides minimal examples. Would be good to include an example for every sub command.

Logs not renamed from addressbook

There are still traces of addressbook in the codebase eg the log files as seen below

App shourtcuts does not work

Help tab shows f1 as a shortcut but pressing f1 does nothing and does not bring up the help tab.

Tabs look confusing

Tabs look as if they are clickable but when clicked they dont do anything.

UG sections should be broken down futhur

For example the add commands like 5 other subcommands in the same section without explaining in more detail what valid parameters are.

Would suggest splitting this up into 5 subsections.

Regex exp used for phone numbers is too permissive

Currenty the constriants for phone numbers is at least 3 characters which allows things lik '000'.

Is find command case sensitive?

Section 4.6 on the find command does not detail if the search being done is case sensitive or not

Varargs in find command are misleading

The ... behind the optional parameter is misleading. If you refer to address book UG, find KEYWORD [MORE KEYWORD] will suffice.

Placeholder text found in help tab

Placholder text "header" has been found in the help tab.

Lack of seeded data

Lack of seed data in the app which makes it hard for testing

Image path is misleading

Full image path is misleading. This would imply image is stored at the root. Might be helpful to present this to the user in a clear manner indicating that it is a relative path.

DG digrams size are not consistent

For exmaple, page 20 of the DG the activity diagram looks so zoomed in. You can use the width and heigh parameter in ascii doctor to control this to make the whole document look alot more consistent.