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

Update deleteCommand for UG #130

Merged
merged 2 commits into from
Apr 4, 2024
Merged

Update deleteCommand for UG #130

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00af54d
Update deleteCommand for UG
sdevih Apr 4, 2024
77b5c74
Update command summary in UG
sdevih Apr 4, 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
8 changes: 4 additions & 4 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ Use the `list` command to reset your view after using the `find` command.
[//]: # (Page Break:)
<div style="page-break-after: always;"> </div>

#### 3.1.7 Deleting a person : `delete`
#### 3.1.7 Deleting a person : `delete`, `del`, `remove`, `rm`

Deletes the specified person from the address book. Deleted person must not be paired with any other person. Additionally, deletion is not allowed if there exists associated logs to the person. A paired person must be unpaired, with all associated logs deleted before the person may be removed from Elder Scrolls, to ensure consistency of data.

Expand All @@ -272,7 +272,7 @@ Format: `delete INDEX r/ROLE`

Examples:
* `list` followed by `delete 2 r/volunteer` Deletes the 2nd volunteer in the address book.
* `find Betsy` followed by `delete 1 r/befriendee` Deletes the 1st befriendee in the results of the `find` command.
* `find Betsy` followed by `del 1 r/befriendee` Deletes the 1st befriendee in the results of the `find` command.

--------------------------------------------------------------------------------------------------------------------
[//]: # (Page Break:)
Expand Down Expand Up @@ -470,10 +470,10 @@ Action | Format, Examples
**Unpair** | `unpair BEFRIENDEE_INDEX VOLUNTEER_INDEX`<br> e.g., `unpair 1 2`
**List** | `list`
**Find** | `find [r/ROLE] [t/TAG] [--paired]/[--unpaired] KEYWORD [MORE_KEYWORDS]...` <br> e.g., `find r/volunteer --paired James`
**Delete** | `delete INDEX r/ROLE`<br> e.g., `delete 3 r/befriendee`
**Delete** | `delete INDEX r/ROLE`<br> `del INDEX r/ROLE`<br> `remove INDEX r/ROLE`<br> `rm INDEX r/ROLE`<br> e.g., `delete 3 r/befriendee`
**LogAdd** | `logadd BEFRIENDEE_INDEX VOLUNTEER_INDEX t/TITLE s/START_DATE d/DURATION r/REMARKS`<br> e.g., `logadd 1 2 t/Movies s/2020-01-09 d/3 r/had popcorn`
**LogEdit** | `logedit INDEX [t/TITLE] [s/START_DATE] [d/DURATION] [r/REMARKS]`<br> e.g., `logedit 1 t/Movies s/2020-01-09 d/3 r/had popcorn`
**LogDelete** | `logdelete INDEX`<br> e.g., `logdelete 1`
**LogDelete** | `logdelete INDEX`<br> `logdel INDEX`<br> `logremove INDEX`<br> `logrm INDEX`<br> e.g., `logdelete 1`
**LogFind** | `logfind INDEX r/ROLE`<br> e.g., `logfind 1 r/befriendee`
**Undo** | `undo`
**Redo** | `redo`
Expand Down
Loading