Skip to content

Commit

Permalink
Merge pull request #302 from itstrueitstrueitsrealitsreal/editUG
Browse files Browse the repository at this point in the history
Fix UG
  • Loading branch information
itstrueitstrueitsrealitsreal authored Apr 15, 2024
2 parents f961701 + 406cb11 commit 6653fba
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
17 changes: 9 additions & 8 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,12 +115,12 @@ Refer to the [Features & Commands](#features--commands) section below for detail
* Example: `02-01-2025 12:00`

* `CLIENT_INDEX` format:
* Must be a *positive integer* from 1 to 2147483647
* Example: `1`
* Must be a *positive integer* from 1 to 2147483647
* Example: `1`

* `MEETING_INDEX` format:
* Must be a *positive integer* from 1 to 2147483647
* Example: `1`
* Must be a *positive integer* from 1 to 2147483647
* Example: `1`

</div>

Expand Down Expand Up @@ -270,7 +270,7 @@ Format: `addMeeting clientIndex/CLIENT_INDEX dt/DATE_TIME d/DESCRIPTION`
- `CLIENT_INDEX` refers to the index number shown in the displayed client list.
- `CLIENT_INDEX` must be a **positive integer** 1, 2, 3, ….
- `DATE_TIME` format should be `DD-MM-YYYY HH:MM`, e.g., `02-01-2025 12:00`, and should be **after
the current datetime**
the current date and time**
- `DESCRIPTION` refers to what the meeting is about. Format should be a single string and be alphanumeric, e.g. d/Meeting-Sales Pitch, **is not allowed.**

Rejected Scenarios:
Expand Down Expand Up @@ -310,11 +310,11 @@ Format: `editMeeting clientIndex/CLIENT_INDEX meetingIndex/MEETING_INDEX n/DESCR
- `MEETING_INDEX` refers to the index number of the meeting for the specific client.
- `MEETING_INDEX` must be a **positive integer** 1, 2, 3, ….
- `DATE_TIME` format should be `DD-MM-YYYY HH:MM`, e.g., `02-01-2025 12:00`, and should be **after
the current datetime**
the current date and time**
- `DESCRIPTION` refers to what the meeting is about. Format should be a single string and be alphanumeric, e.g. d/Meeting-Sales Pitch, **is not allowed.**

- Edits the meeting specified by `MEETING_INDEX` for the client specified by `CLIENT_INDEX`. Both indexes must be positive integers 1, 2, 3, ….
- All the fields (clientIndex, meetingIndex, description, datetime), must be provided.
- All the fields (clientIndex, meetingIndex, description, date and time), must be provided.
- Existing values will be updated to the input values.
- When editing descriptions, the existing descriptions of the meeting will be removed i.e.
adding of descriptions is not cumulative.
Expand All @@ -323,7 +323,8 @@ Format: `editMeeting clientIndex/CLIENT_INDEX meetingIndex/MEETING_INDEX n/DESCR

Examples:

- `editMeeting clientIndex/1 meetingIndex/2 n/starbucks meeting dt/01-01-2025 12:00` Edits the description and date/time of the 2nd meeting of the 1st client.<br>
- `editMeeting clientIndex/1 meetingIndex/2 n/starbucks meeting dt/01-01-2025 12:00` Edits the
description, date and time of the 2nd meeting of the 1st client.<br>
![edit meeting result](images/release_images/editMeeting.png)

#### Deleting a Meeting: `deleteMeeting`
Expand Down
1 change: 1 addition & 0 deletions docs/team/itstrueitstrueitsrealitsreal.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Given below are my contributions to the project.
* **Project management**:
* Set up the GitHub team organisation and the repository
* Set up and maintained the issue tracker for [`v1.1`](https://github.com/AY2324S2-CS2103-F08-1/tp/milestone/1), [`v1.2`](https://github.com/AY2324S2-CS2103-F08-1/tp/milestone/2), [`v1.3`](https://github.com/AY2324S2-CS2103-F08-1/tp/milestone/3) [`v1.4`](https://github.com/AY2324S2-CS2103-F08-1/tp/milestone/4) on GitHub
* Managed the release of [`v1.4`](https://github.com/AY2324S2-CS2103-F08-1/tp/releases/tag/v1.4) on GitHub

* **Documentation**:
* User Guide:
Expand Down

0 comments on commit 6653fba

Please sign in to comment.