Skip to content

Commit

Permalink
Update User Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
yuxunn committed Oct 26, 2023
1 parent 833d99a commit cc2cb67
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 4 deletions.
31 changes: 29 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ addclient: Adds a client to the address book. Parameters: n/NAME p/PHONE e/EMAIL
Example: addclient n/John Doe p/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25 t/classmate
```

### View all clients
### List all clients

- What it does: View all clients you have stored, including their basic information and index in the list of clients, e.g. id, name, age, gender, occupation, etc.
- Command: `listclient`.
Expand All @@ -110,7 +110,7 @@ In output section of the
<p>After using listclient command</p>
</div>

### View all leads
### List all leads

- What it does: View all leads you have stored, including their basic information and index in the list of leads, e.g. id, name, age, gender, occupation, etc.
- Command: `listlead`.
Expand All @@ -127,6 +127,33 @@ In output section of the
<p>After using listlead command</p>
</div>

### View Specific Person

- What it does: View a specific person that you have stored, including their basic information and another relevant lead/client
details.
- Command: `view INDEX`.
- Example usage: `view 1`.
- Acceptable values for `INDEX` parameter:
- Must be an integer from `1` to the last index of the main list.
- Precise expected output when the command succeeds:

`Viewed Person Successfully`

- Precise expected output when command fails:

`The person index provided is invalid`

<h4>Example usage:<h4>

<div align="center">
<img src="./images/ViewExample.png" width="500" />
<p>After using View Command on a Lead</p>
</div>

<div align="center">
<img src="./images/ViewExampleClient.png" width = "500"/>
<p>After using View Command on a Client</p>
</div>

### Delete [Coming soon]

Expand Down
Binary file added docs/images/ViewExample.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/ViewExampleClient.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ public Command parseCommand(String userInput) throws ParseException {

case ListLeadCommand.COMMAND_WORD:
return new ListLeadCommand();

case ConvertLeadToClientCommand.COMMAND_WORD:
return new ConvertLeadToClientCommandParser().parse(arguments);

Expand All @@ -100,7 +99,6 @@ public Command parseCommand(String userInput) throws ParseException {

case ViewCommand.COMMAND_WORD:
return new ViewCommandParser().parse(arguments);

default:
logger.finer("This user input caused a ParseException: " + userInput);
throw new ParseException(MESSAGE_UNKNOWN_COMMAND);
Expand Down

0 comments on commit cc2cb67

Please sign in to comment.