Skip to content

Commit

Permalink
Merge pull request nus-cs2103-AY2324S1#127 from jx124/update-ug
Browse files Browse the repository at this point in the history
Update UG for AddMeeting and SortMeeting commands
  • Loading branch information
garylow2001 authored Nov 2, 2023
2 parents 80b7f87 + ab70cef commit dbcde1f
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 6 deletions.
56 changes: 50 additions & 6 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,19 +188,40 @@ Parameters: INDEX (must be a positive integer)

### Add meeting time

- What it does: Adds a meeting time for a lead
- Command format: `addmeetingtime INDEX m/MEETING_TIME`
- Example usage: `addmeetingtime 1 m/12/12/2020 12:00`
- What it does: Adds a meeting time to a person.
- Command format: `addmeeting INDEX m/MEETING_TIME`
- Example usage: `addmeeting 1 m/12/10/2023 16:00`

<div align="center">
<img src="./images/beforeaddmeeting.png" width = "500"/>
<p>Before using addmeeting</p>
</div>

<div align="center">
<img src="./images/afteraddmeeting.png" width = "500"/>
<p>After using addmeeting</p>
</div>

- Acceptable values for each parameter:
- `INDEX`: Any integer from `1` to the last index of the leads list.
- `INDEX`: Any integer from `1` to the last index of the displayed list.
- `MEETING_TIME`: A string of format `dd/MM/yyyy HH:mm`.
- Precise expected outputs when the command succeeds:

`Meeting time added to <lead/client> : <meeting datetime>`
`Added Meeting: <meeting datetime> to Person <index>`

- Precise expected outputs when the command fails:

`Meeting time failed to add. Please enter a valid lead id or meeting time`
When adding a meeting time to an invalid index or with an invalid datetime format:
```
Invalid command format!
addmeeting: Adds a new meeting time to the person identified by the displayed index in the address book.
Parameters: INDEX (must be a positive integer) m/MEETING_TIME
Example: addmeeting 1 m/12/10/2023 16:00
```

When adding a meeting time to a person who already has an existing meeting:

`Person already has a meeting time, use the edit command instead`

### Delete meeting time for lead

Expand All @@ -218,6 +239,28 @@ Parameters: INDEX (must be a positive integer)

`Meeting time failed to be deleted. Please enter a valid lead id or meeting time`


### Sort meeting time

- What it does: Sorts the meeting times of all leads and clients chronologically, displaying
only entries with a meeting time.
- Command format: `sortmeeting`
- Example usage:

<div align="center">
<img src="./images/beforesortmeeting.png" width = "500"/>
<p>Before using sortmeeting</p>
</div>

<div align="center">
<img src="./images/aftersortmeeting.png" width = "500"/>
<p>After using sortmeeting</p>
</div>

- Precise expected outputs when the command succeeds:

`Sorted all meeting times chronologically`

### Convert lead to client

- What it does: Converts a lead to client.
Expand Down Expand Up @@ -248,3 +291,4 @@ from current date to ensure a followup by the user
- Precise expected outputs when the command fails:

`The person index provided is invalid`

Binary file added docs/images/afteraddmeeting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/aftersortmeeting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/beforeaddmeeting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/beforesortmeeting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dbcde1f

Please sign in to comment.