xenosf / ped Goto Github PK

When command is run with "extra" (invalid) arguments, the extra arguments are taken as part of the previous argument. As a result, the displayed error message is confusing to the user and does not fully describe the issue. (Extra confusing for fields like IC that cannot take spaces)

After using clear, the result message says "AddressBook has been cleared" which is confusing as the app is not an address book.

The examples of the edit patient command as seen in the UG do not follow the specified format, and cause errors when pasted into the app.

Examples given in UG:

• edit T0123456A n/John Doe a/33 g/m b/01-01-1990 i/T0123456A p/98765432 e/[email protected] a/John street, block 123, #01-01
• edit T6543210F n/Betsy Crowe p/87386298 a/20 g/Female b/02-02-2003 e/[email protected] a/Brighton Town i/T6543210F

Screenshot of error when running John Doe example command:

Screenshot of UG with possible errors highlighted:

1. [yellow highlight] IC is specified in the beginning of the command and the i/ argument (UG says i/ is for IC)
2. [blue highlight] Duplicate a/ argument used to input both age and address (UG says a/ is for address)

Updating multiple fields only updates the first one.

Command tested: record i/T0201234A o/Broken Arm d/Hairline fracture t/Cast for 2 days r/Patient stable condition, no need for anesthetics a/Yes (copied from UG)

The hyperlink to the appendix does not work when clicked.

The save file is named addressbook.json, which is visible in the main app window, which is confusing as the app is A&E, not AB.

According to the UG, the view command "displays a specific patient's information and medical record". However, the command only lists the specified patient, and the user has to click on the listing to view the patient's information and medical record. This step seems unnecessary as there can only be one patient with a given IC number.

For the edit patient records command, UG says the order of the input fields does not matter, but there is an error when the fields are rearranged.

Commands tested:

1. (no error shown) record i/T7654321A o/Broken Arm d/Hairline fracture t/Cast for 2 days r/Patient stable condition, no need for anesthetics
2. (error shown): record i/T7654321A t/Cast for 2 days d/Hairline fracture o/Broken Arm r/Patient stable condition, no need for anesthetics. Screenshot:
   

The UG specifies some constraints for hospital departments in the app.

However, these restrictions are based on specific assumptions about the end user's use case, and may be needlessly restrictive to the users and reduce the app's usefulness. Some examples that come to mind:

• What if the user's hospital is in a location where American spelling is the standard (e.g. USA) -- should they be forced to use British spelling conventions?
• What if the user's hospital has a department that is not in the accepted list of departments in this app?
  • Could be better if users are allowed to set up a list of departments in their hospital/edit the accepted departments list to suit their needs.

Step 5 of the UG Quick Start instructs the user to type in cd Desktop\A&E to change directory to the A&E folder. However, the path provided only works on Windows (backslash). The path may need to be in quotes as well, since the ampersand (&) in A&E may be treated as a special character in terminal commands.

Tested using MacOS Terminal.app & zsh.

Clicking on the links in the table of contents at the top of the main UG (or other hyperlinks in the UG) does not work -- browser does not jump to the relevant header. However, the links in the table of contents on the right of the page work.

Some info that may help in troubleshooting:

• URL from working ToC:
  https://ay2324s1-cs2103t-t14-2.github.io/tp/UserGuide.html#finding-a-patient-by-name-find
• URL from not working ToC:
  https://ay2324s1-cs2103t-t14-2.github.io/tp/UserGuide.html#finding-a-patient-by-name--find

Tested on Firefox on MacOS.

I'm not sure what exactly caused this problem (my guess is something to do with how MarkBind vs GitHub Flavored Markdown generates anchor slugs for headers, as my team's UG links [using Jekyll] works fine). Hopefully the info given above helps.

The first part of the documentation for record specifies o/, d/, t/ as optional fields. However, the example command given has an extra field a/.

UI screenshot does not appear correctly in step 5 of the UG quick start section. Screenshot:

UG viewed using Firefox on MacOS.