Skip to content

Commit

Permalink
Merge pull request #392 from tingxuanp/update-UG
Browse files Browse the repository at this point in the history
Update UG
  • Loading branch information
dasha3412 authored Nov 11, 2024
2 parents 15e4c52 + e8e23b9 commit 60603cc
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 20 deletions.
41 changes: 21 additions & 20 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,7 @@ The WEDDING_NUMBER corresponds to each Wedding's position in the `Wedding` list
* To edit the address of the Wedding named `Wedding!`, to XYZ street:
* First, identify the Wedding number by entering the command: `list-weddings`
* Should wedding number be 1, enter the command: `edit-wedding 1 a/XYZ street`
* Should the Wedding number of `Wedding!` be 1, enter the command: `edit-wedding 1 a/XYZ street`. If the Wedding number is different, simply replace the 1 in the command with the corresponding Wedding positional number.
<br>
Expand Down Expand Up @@ -623,6 +623,9 @@ Examples:
* To delete the wedding named `Wedding 1`, enter the command:
* `delete-wedding w/Wedding 1`
**Known issue:** the `unassign-wedding` command is case-sensitive, so if person 2 is assigned to the wedding, Wedding 2, only entering the command `unassign-wedding 2 w/Wedding 2` or `uw 2 w/Wedding 2`
will unassign the wedding from person 2 and `unassign-wedding 2 w/wedding 2` or `uw 2 w/wedding 2` will not.
---
<br>
Expand Down Expand Up @@ -736,9 +739,9 @@ Examples:
<br>
### Unmarking a task : `unmark-task` or `untask`
#### Unmarking a task : `unmark-task` or `untask`
You can mark one or more Tasks as not completed by using the `unmark-task` command.
You can mark one or more `Tasks` as not completed by using the `unmark-task` command.
Format: `unmark-task TASK_NUMBER...` or `untask TASK_NUMBER...`
Expand All @@ -749,12 +752,12 @@ Following that, type `unmark-task` followed by the Task number(s).
Examples:
* To mark the completed task with the description `Finalise itinerary` as incomplete:
* First, identify the Task number of the task.
* First, identify the Task number of the task by entering the command: `list-tasks`.
* Should the Task number be 1, enter the command `unmark-task 1`.
<br>
### Deleting a Task : `delete-task` or `dtask`
#### Deleting a Task : `delete-task` or `dtask`
You can delete a specific Task from WedLinker by using the `delete-task` command.
Expand All @@ -767,45 +770,43 @@ Following that, type "delete-task" and the Task number of the task that you wish
Examples:
* To delete a task with the description `Buy cake`:
* First, identify the Task number by entering the command: `list-tasks`
* Should the Task number be 1, enter the command: `delete-task 1`
* First, identify the Task number by entering the command: `list-tasks`.
* Should the Task number be 1, enter the command: `delete-task 1`.
---
<br>
<h3 class="features">Vendor Features</h3>
### Assigning a Vendor : `assign-vendor` or `asv`
#### Assigning a Vendor : `assign-vendor` or `asv`
Use the `assign-vendor` command to designate a contact as a vendor.
You can use the `assign-vendor` command to designate a contact to be a Vendor.
Format: `assign-vendor PERSON_NUMBER` or `asv PERSON_NUMBER`
To designate a contact as a vendor, type "assign-vendor" followed by the positional number of the person.
> [!NOTE]
> Vendors can be managed with the same functionalities as a regular contact, e.g. Vendors can be assigned to Weddings, be assigned with tags etc.
To designate a contact as a Vendor, type `assign-vendor` followed by the positional number of the person in the contact list.
* Vendors can be managed with the same functionalities as a regular contact, e.g. Vendors can be assigned to Weddings, can be assigned with tags etc.
* The `PERSON_NUMBER` **must be a positive integer** 1, 2, 3, …​.
* The `Vendor` can now have `Tasks` assigned to them.
Examples:
* To designate the first contact as a vendor, enter the command:
* To designate the first contact in the person list as a vendor, enter the command:
* `assign-vendor 1`.
<br>
### Unassigning a Vendor : `unassign-vendor` or `uv`
#### Unassigning a Vendor : `unassign-vendor` or `uv`
Use the `unassign-vendor` command to remove a vendor designation from a contact, making them a regular contact in WedLinker.
You can use the `unassign-vendor` command to remove a `Vendor` designation from a contact, making them a regular non-vendor contact in WedLinker.
Format: `unassign-vendor PERSON_NUMBER [f/]` or `uv PERSON_NUMBER [f/]`
To remove a vendor designation from a contact, type "unassign-vendor" followed by the positional number of the person.
To remove a `Vendor` designation from a contact, type `unassign-vendor` followed by the positional number of the person in the contact list.
* The `PERSON_NUMBER` **must be a positive integer** 1, 2, 3, …​.
* Unassigns a `Vendor` at the specified `PERSON_NUMBER` such that the `Person` is no longer a `Vendor`. `Tasks` can no longer be assigned to this `Person`.
* No tasks should be assigned to the `Vendor` before it is unassigned.
* If the specified `Vendor` has tasks assigned to them, you can use the label `f/` to force the removal of the vendor designation and remove all tasks currently assigned to that `Vendor`.
* A regular contact can no longer have `Tasks` assigned them.
* No tasks should be assigned to the `Vendor` before they are unassigned.
* However, if the specified `Vendor` has tasks assigned to them, you can use the label `f/` to force the removal of the vendor designation and remove all tasks currently assigned to that `Vendor`.
Examples:
* To remove a vendor designation from the first contact, enter the command:
Expand Down
Binary file modified docs/images/Ui.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 60603cc

Please sign in to comment.