From 6a986acb3cb9b2f7e97f90511d9cacd267fbdbde Mon Sep 17 00:00:00 2001 From: "LAPTOP-NQHH6Q7K\\Juanpa" Date: Mon, 13 Nov 2023 20:59:09 +0800 Subject: [PATCH 1/5] Add clear, exit, and help to UG --- docs/UserGuide.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index b7113877811..530605008b7 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -669,6 +669,43 @@ Reminds you of upcoming deadlines for job applications. | `remind` | No urgency level specified. | +### Viewing help - `help` + +##### Format +```sh +help +``` + +Shows a message explaining how to access the help page. + +![Help Message](images/helpMessage.png) + + +### Clearing all data - `clear` +
Organization Recruiter Job Application
+ +:warning: The deletion of all data is permanent and there is no way to undo it. + +:trophy: How to clear all contacts and job applications in Jobby Intermediate + +##### Format +```sh +clear +``` + +Clears all data from your Contacts and Job Applications. + + +### Exiting the program - `exit` + +##### Format +```sh +exit +``` + +Exits the program. + + -------------------------------------------------------------------------------------------------------------------- ## Command Summary From 6d01ea06728d5c9360bfb018320df6c819e4823b Mon Sep 17 00:00:00 2001 From: "LAPTOP-NQHH6Q7K\\Juanpa" Date: Mon, 13 Nov 2023 21:02:37 +0800 Subject: [PATCH 2/5] Add suitable tags to help and exit --- docs/UserGuide.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 530605008b7..bbd79d4955b 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -671,6 +671,8 @@ Reminds you of upcoming deadlines for job applications. ### Viewing help - `help` +Beginner + ##### Format ```sh help @@ -698,6 +700,8 @@ Clears all data from your Contacts an ### Exiting the program - `exit` +Beginner + ##### Format ```sh exit From 7e4213a4165428745559bda4f902a4bf9469d221 Mon Sep 17 00:00:00 2001 From: "LAPTOP-NQHH6Q7K\\Juanpa" Date: Mon, 13 Nov 2023 21:13:03 +0800 Subject: [PATCH 3/5] Add known issues to UG --- docs/UserGuide.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index bbd79d4955b..988ab7eae61 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -784,6 +784,10 @@ Exits the program. -------------------------------------------------------------------------------------------------------------------- -## Issues +## Known 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. From c60ab3e3b9ba6c10d093ebe054f06976641cefd0 Mon Sep 17 00:00:00 2001 From: McNaBry Date: Mon, 13 Nov 2023 21:44:34 +0800 Subject: [PATCH 4/5] Update wording and style for clear --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 73555d9cafc..f795b8c13aa 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -695,7 +695,7 @@ Shows a message explaining how to access the help page. clear ``` -Clears all data from your Contacts and Job Applications. +Clears all Contact and Job Application data from Jobby. ### Exiting the program - `exit` From 312ef4241b05788d3ae0d5510c8a4912413d640c Mon Sep 17 00:00:00 2001 From: McNaBry Date: Mon, 13 Nov 2023 21:47:54 +0800 Subject: [PATCH 5/5] Add learning outcomes for help and exit --- docs/UserGuide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index f795b8c13aa..80e214bba64 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -671,7 +671,7 @@ Reminds you of upcoming deadlines for job applications. ### Viewing help - `help` -Beginner +:trophy: How to find help on Jobby's commands Beginner ##### Format ```sh @@ -700,7 +700,7 @@ Clears all Contact and Beginner +:trophy: How to exit Jobby Beginner ##### Format ```sh