Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix grammatical errors in DG #380

Merged
merged 2 commits into from
Nov 12, 2024
Merged

Fix grammatical errors in DG #380

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
deb2ddc
Fix grammatical errors in DG
vinc3leong Nov 12, 2024
967f543
Fix DG formatting
vinc3leong Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,7 @@ ___

**Extensions**:
- **1a.** VV detects that the supplier is missing or invalid.

- **1a1.** VV displays an error message.
Use case ends.

Expand Down Expand Up @@ -271,6 +272,7 @@ ___
- **1c1.** VV displays an error message.
Use case ends.

___
**System**: Vendor Vault (VV)

**Use Case**: UC04 - Find Supplier by given parameters
Expand Down Expand Up @@ -302,6 +304,7 @@ ___
1. User requests to sort suppliers by a specified field in a specified order.
2. VV sorts the suppliers and displays the sorted list of suppliers.
Use case ends.

**Extensions**:
- **1a.** VV detects an invalid command format.
- **1a1.** VV displays an error message.
Expand Down Expand Up @@ -369,6 +372,7 @@ ___
2. VV displays a confirmation message and then shows an updated list of all deliveries.
Use case ends.

**Extensions**:
- **1a.** VV detects an invalid command format.
- **1a1.** VV displays an error message.
Use case ends.
Expand Down Expand Up @@ -654,6 +658,7 @@ testers are expected to do more *exploratory* testing.
### Listing all deliveries

1. Listing all deliveries

1. Test case: `list -d`<br>
Expected: All added deliveries shown. Success message shown in the status message.

Expand Down Expand Up @@ -692,14 +697,14 @@ testers are expected to do more *exploratory* testing.

### Deleting a delivery

1. deleting an existing delivery
1. Deleting an existing delivery

1. Prerequisites: Ensure there is at least 1 delivery by listing all deliveries using the `list -d` command.

1. Test case: `delete -d 1`<br>
Expected: The first delivery is deleted. Details of the deleted delivery shown in the status message.

2. deleting a non-existent delivery
2. Deleting a non-existent delivery

1. Prerequisites: Ensure there is no delivery by listing all deliveries using the `list -d` command.

Expand Down Expand Up @@ -727,10 +732,10 @@ testers are expected to do more *exploratory* testing.

3. Finding a delivery that does not exist

1. Prerequisites: Ensure there is no deliveries with 20-10-1999 12:00 as DELIVERY_DATE_TIME by listing all deliveries using the `list -d` command.
1. Prerequisites: Ensure there are no deliveries with 20-10-1999 12:00 as DELIVERY_DATE_TIME by listing all deliveries using the `list -d` command.

1. Test case: `find -d on/20-10-1999 12:00`<br>
Expected: No deliveries is displayed. Message indicating 0 deliveries listed shown in the status message.
Expected: No deliveries are displayed. Message indicating 0 deliveries listed shown in the status message.

4. Other incorrect find commands to try: find -d, find -d pro/@@## ...
Expected: No delivery is displayed and error message is shown in the status message.
Expand All @@ -747,14 +752,14 @@ testers are expected to do more *exploratory* testing.
2. Sorting deliveries with invalid parameters in ascending order

1. Test case: `sort -d so/a sb/q`<br>
Expected: No deliveries displayed. Error message indicating possible parameters for sort order shown in the status message.<br></br>
Expected: No deliveries are displayed. Error message indicating possible parameters for sort order shown in the status message.<br></br>

3. Sorting an empty list of deliveries

1. Prerequisites: Ensure there is no deliveries displayed by listing all deliveries using the `list -d` command.
1. Prerequisites: Ensure there are no deliveries displayed by listing all deliveries using the `list -d` command.

1. Test case: `sort -d so/a sb/c`<br>
Expected: No deliveries is displayed. Message indicating 0 deliveries sorted by cost in ascending order is shown in the status message.
Expected: No deliveries are displayed. Message indicating 0 deliveries sorted by cost in ascending order is shown in the status message.

4. Other incorrect sort -d commands to try: sort -d, sort -d so/a ...
Expected: No delivery is displayed and invalid command error message is shown in the status message.
Expand Down Expand Up @@ -892,6 +897,7 @@ Team size: 5
* **Tasks**:
* We plan to allow for adding a supplier name with special characters.
* e.g. "add -s n/John Doe & Sons p/98765432
* e.g. "add -s n/John Doe s/o connor p/98765432


9. **Enhancement 9**: Better input checks for invalid date in commands that require date input.
Expand Down