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

Close #81 Update formatting for UserGuide #84

Merged
merged 3 commits into from
Oct 4, 2023
Merged

Close #81 Update formatting for UserGuide #84

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c86e94
Update formatting for UserGuide
jianyangg Oct 3, 2023
82f3059
Merge branch 'master' into 58-update-userguide-deliveries
jianyangg Oct 3, 2023
de44407
Merge branch 'master' into 58-update-userguide-deliveries
juliusgambe Oct 4, 2023
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
33 changes: 19 additions & 14 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,24 +245,29 @@ _Details coming soon..._

Shows a list of all deliveries.

**Format:** `delivery list STATUS [--sort SORT]`
**Format:** `delivery list [STATUS] [--sort SORT]`

**Example:** `delivery list all --sort desc`
**Example:** `delivery list pending --sort desc`

**Accepted Values:**

_STATUS_: String of either `all` or `pending` or `complete`
_STATUS_: String of either `pending` or `complete` or defaults to show all deliveries

_SORT_: String of either `asc` for ascending or `desc` for descending or empty string for sorting by delivery date
_SORT_: String of either `asc` for ascending or `desc` for descending or defaults to sort by delivery date

**Command succeeds (>0 deliveries):** _Here are all the deliveries:_
**Command succeeds (>0 deliveries):**

1. _[1001] Gabriel’s Milk - Completed - Ordered 20th Sept 2023: Delivered on 30th Sept 2023_
2. _[1002] Gambe’s Meat - Completed - Ordered 22th Sept 2023: Delivered on 29th Sept 2023_
3. _[1003] Ben’s Coffee - Pending - Ordered 25th Sept 2023: Delivery on 1st October 2023_

**Command failed (0 deliveries):** _There are currently no deliveries!_

### View deliveries for the day `[Coming Soon in v1.3]`

_Details coming soon..._


### View details of deliveries

Shows the details of the specified delivery.
Expand All @@ -287,6 +292,10 @@ _Delivery on: 1st October 2023_

**Command failed (0 deliveries):** _There are currently no deliveries._

### Look up delivery details `[Coming Soon in v1.3]`

_Details coming soon..._

### Update delivery status and date

- Mark delivery as complete
Expand Down Expand Up @@ -349,6 +358,10 @@ _DATE:_ String of format YYYY-MM-DD

**Command failed (delivery_id not in database):** _This delivery does not seem to exist!_

### Add customer data to delivery `[Coming Soon in v1.3]`

_Details coming soon..._

### Delete delivery

Deletes the specified delivery.
Expand All @@ -367,18 +380,10 @@ _DELIVERY_ID_: Integer

**Command failed (delivery_id not in database):** _This delivery does not seem to exist!_

### View deliveries for the day `[Coming Soon in v1.3]`

_Details coming soon..._

### Add customer data to delivery `[Coming Soon in v1.3]`

_Details coming soon..._

### Remove customer from delivery `[Coming Soon in v1.3]`

_Details coming soon..._

### Look up delivery details `[Coming Soon in v1.3]`
### Create a note for a delivery `[Coming Soon in v1.3]`

_Details coming soon..._