juliapoo / pe Goto Github PK

About

Updating the contact list, especially for an command (where the added note does not appear in the left contact list box), should update the right box to view the updated contact (like in the view command).

This allows the user to have quick feedback on what got updated, especially so for the an command where the user can immediately see where the note ended up.

Expected

Actual

About

Not allowing brackets restricts the kind of messages that one can place in the notes sections, such as the one above.

In the section Editing the data file, the UG states that the file will be TAToolkit.json. However, what is implemented is tatoolkit.json. This works fine for case-insensitive file systems like that of windows like NTFS, but not for unix-like file systems such as that from MacOS and Linux.

About

In the Command Summary, p/ is a compulsory variable, but it is documented as an optional variable in the section Adding a person: ac

In the command summary

In the command documentation

About

Currently, week numbers are restricted to 1 to 13 inclusive.

However, some modules start at week 0, and might want to track attendance then.

The block of text after 1. Ensure you have Java 11 or above installed on your computer. should be left-padded to match the indentation of the list contents.

About

Throughout the UG, the application assumes each student is a he, but this does not reflect students in real life. Suggest to use they or he/she.

Example

This problem is quite evident in the right box element, as the background is very close to white.

About

The text has no padding space in the box:

This makes the text slightly harder to read and is inconsistent with the rest of the UI as all other text in the UI has padding.

This is an issue throughout the UG, but as an illustration:

In the section Adding a person: ac, the variable names should be inside an inline codeblock.

About

A corrupted tatoolkit.json causes it to be completely overwritten upon graceful exit of the application. This presents a huge risk to the user as a corrupted database can result from many things including but not exclusively:

1. Un-graceful termination of the program during serialisation
2. Crash of the operating system (e.g., Blue Screen on windows)
3. Bug in the serialisation (or deserialisation) of the database in the application.

This means it is very easy for a user to lose all of their data.

Replication steps

1. Launch the application for the first time.
2. Run exit
3. Open data/tatoolkit.json and edit the note of a person to include a /:
4. Launch the application another time.
5. Run exit (to trigger the serialisation of the empty database).

At the end, tatoolkit.json will be completely overwritten with an empty database.

Expected

The application should backup the data and display a warning to the user.

Test thingy

About

This might hinder the inclusion of certain notes, such as URLs (shown below):

About

The Note should not be an inline-code block and the ** should have bolded the section.

About

If more than 13 values are present in the attendance field, the application fails to start at all:

Expected

The application backs-up the database, launches with a message saying the database is corrupted, and give the user options to contact the developers/deal with the problem.

In the format section, the name NOTE_INDEX is used, but in the rest of this section, the name NOTEINDEX is used.

About

Upon application bootup, the message below appears on the right box:

However, the list command no longer exist and is instead the ls command.

The following is from the Notes about command format section:

However, this is not followed in commands such as dn where ... means "," seperated.