Skip to content

Commit

Permalink
Merge pull request AY2324S1-CS2103T-W08-3#195 from wamps-jp/branch-UG…
Browse files Browse the repository at this point in the history
…-final

Add `clear`, `exit`, and `help` to UG
  • Loading branch information
McNaBry authored Nov 13, 2023
2 parents 6437d39 + 2c3197e commit 1b6226f
Showing 1 changed file with 46 additions and 1 deletion.
47 changes: 46 additions & 1 deletion docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -669,6 +669,47 @@ Reminds you of upcoming deadlines for job applications.
| `remind` | No urgency level specified. |


### Viewing help - `help`

<span class="learning-outcome pill">:trophy: How to find help on Jobby's commands</span> <span class="beginner pill">Beginner</span>

##### Format
```sh
help
```

Shows a message explaining how to access the help page.

![Help Message](images/helpMessage.png)


### Clearing all data - `clear`
<div class="applies-to pill"><span class="jobby-data-class pill">Organization</span> <span class="jobby-data-class pill">Recruiter</span> <span class="jobby-data-class pill">Job Application</span></div>

<span class="danger pill">:warning: The deletion of all data is permanent and there is no way to undo it.</span>

<span class="learning-outcome pill">:trophy: How to clear all contacts and job applications in Jobby</span> <span class="intermediate pill">Intermediate</span>

##### Format
```sh
clear
```

Clears all <span class="jobby-data-class">Contact</span> and <span class="jobby-data-class">Job Application</span> data from Jobby.


### Exiting the program - `exit`

<span class="learning-outcome pill">:trophy: How to exit Jobby</span> <span class="beginner pill">Beginner</span>

##### Format
```sh
exit
```

Exits the program.


--------------------------------------------------------------------------------------------------------------------

## Command Summary
Expand Down Expand Up @@ -765,4 +806,8 @@ Reminds you of upcoming deadlines for job applications.
--------------------------------------------------------------------------------------------------------------------
## Issues

(Where to report issues and what bugs currently exist)
1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the _preferences.json_ file created by the application before running the application again.

2. **When requesting to sort applications after a call to `list --rec`**, the command will succeed but display nothing, since no organizations are currently listed, and so no linked applications will display. The remedy is to call `list` before sorting applications and calling the sort command once more.

3. Parameter names use either the `-` or `--` prefix, but **all commands as of the current version only use the `--` prefix.** The `-` prefix is currently unused, but in future updates it may become relevant.

0 comments on commit 1b6226f

Please sign in to comment.