t-wan-lin / pe

• 👋 Hi, I’m @T-Wan-Lin
• 👀 This is my Github page where I keep track of all projects and learning materials :)
• 🌱 I’m currently getting a degree in Computer Engineering @ NUS
• 📫 You can email me at [email protected]
• LinkedIn: www.linkedin.com/in/tan-wan-lin

pe's Issues

Invalid command not handled

Extra parameters in exit command will still be accepted.

Implausible scenario should be excluded

It's not possible for a real-life venue to have a size of 0 (as per the UG description), consider having a realistic lower bound for the venue size.

Inconsistency in sequence diagrams

It would be good to standardise the adding/omission of the crosses to show when an object is deleted/no longer referenced across all sequential diagrams in the DG.

Extra parameters before `add` command not handled

Extra parameters in invalid add command not handled, the wrong exception thrown.

Highly Relevant NFRs missing

Highly relevant NFRs are not mentioned, such as performance NFRs (How should the app ideally behave when there are many companies >100 etc.) Some of the NFRs here should belong in functional requirements, such as the application's behaviour when the text files are mutated.
Just for reference about what NFRs should include (from textbook)

No reprompting to enter event name

Lack of list confirmed command

If a user has a long list of companies, it would be very helpful to be able to list out all companies that have confirmed their attendance rather than just those that have not confirmed. This is because you have a confirm and unconfirm command which gives due consideration that a company may pull out at the last minute. Being able to have the opposite of list unconfirmed would be very helpful, rather than having to trawl through the whole list with the list companies command. The omission of such a command is strange.

Missing Hyperlink in DG

Is this meant to be a hyperlink? It's blue but it doesn't jump to the section highlighted. When double-clicked, it highlights the text instead. The content page hyperlinks work though.

Words on Command class diagram hard to read

Words displayed in the command class diagram are very small and pixelated, making them hard to read.

Necessity for Ui Class Diagram

Is a class diagram for Ui necessary? It is rather long and would get outdated quickly (if you were to update it), given the many methods you have. The sequence diagram for Ui is much more meaningful in the DG

Venue list UI issues

It would help if the venue size was in the UI, like at the end, you can have Venue Size: 100, instead of a raw number 100.

Imprecise exception for number

Would be useful if the user were informed that their phone number is too small to alert them that there is a missing digit.

Glossary Issues

For item 1, that's a bit obvious.

For item 2, you wrote it at the beginning of the DG, making it a bit redundant to redefine it here.

You could have defined terms like Operating Systems etc, if the user isn't tech-inclined and doesn't know what OS means

Incorrect flag command error not handled

User may type in /n instead of n/ as per the UG, but this is not caught as an invalid format.

Acceptance of invalid email address

Sometimes users may accidentally hit enter before they complete the email address. Instead of checking for the presence of @, perhaps you could check if the email at least has a suffix like (.com.sg)

Instructions in Manual Testing is lacking

Considering that this is for testing, there should be more cases, in accordance with AB3 sample DG.

Dummy Issue

Dummy edit