Update UserGuide.md #140

limjunxian1 · 2023-11-01T14:41:13Z

This PR will:

Finish updating all features under manage contact except updatephoto
Updates notes under feature section and planned enhancements for some minor bugs that cannot be fixed (and people may complain that it is a bug)

Closes #139

# Conflicts: # docs/UserGuide.md

lordidiot

Looks really good. Just some minor language changes, then let's merge this 👍

lordidiot · 2023-11-01T15:18:57Z

docs/UserGuide.md

@@ -170,16 +171,16 @@ All planned enhancements will also be listed in the [Planned Enhancements / Know
 **Notes about the command format:**<br>

 * Words in `UPPER_CASE` are the parameters to be supplied by the user.<br>
-  e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`.
+  e.g. In `add n/NAME`, `NAME` is an parameters which can be used as `add n/John Doe`.


Isn't a parameter correct here?

yes agreed, fixed in b33ffa8

lordidiot · 2023-11-01T15:19:55Z

docs/UserGuide.md


-* Items in square brackets are optional, ___with `addalt` as an exception. (Refer to [Add alternative information to contact](#add-alternative-information-to-contact) under Features)___<br>
-  e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`.
+* Parameters in square brackets are optional fields, **with `addalt` and `edit` as an exception. (Refer to [Add alternative information to contact](#add-alternative-information-to-contact) and [Edit contact information](#edit-contact-information) under Features)**<br>


Suggested change

* Parameters in square brackets are optional fields, **with `addalt` and `edit` as an exception. (Refer to [Add alternative information to contact](#add-alternative-information-to-contact) and [Edit contact information](#edit-contact-information) under Features)**<br>

* Parameters in square brackets are optional, **with `addalt` and `edit` as an exception. (Refer to [Add alternative information to contact](#add-alternative-information-to-contact) and [Edit contact information](#edit-contact-information) under Features)**<br>

Not all parameters are fields

fixed in b33ffa8

lordidiot · 2023-11-01T15:20:33Z

docs/UserGuide.md

-* Items in square brackets are optional, ___with `addalt` as an exception. (Refer to [Add alternative information to contact](#add-alternative-information-to-contact) under Features)___<br>
-  e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`.
+* Parameters in square brackets are optional fields, **with `addalt` and `edit` as an exception. (Refer to [Add alternative information to contact](#add-alternative-information-to-contact) and [Edit contact information](#edit-contact-information) under Features)**<br>
+  e.g In `n/NAME [t/TAG]`, `[t/TAG]` is an optional field which can be used as `n/John Doe t/friend` or as `n/John Doe`.


Suggested change

e.g In `n/NAME [t/TAG]`, `[t/TAG]` is an optional field which can be used as `n/John Doe t/friend` or as `n/John Doe`.

e.g In `n/NAME [t/TAG]`, `[t/TAG]` is an optional parameter which can be used as `n/John Doe t/friend` or as `n/John Doe`.

ditto

fixed in b33ffa8

lordidiot · 2023-11-01T15:32:48Z

docs/UserGuide.md

-    * Adds John Doe's linkedin "john-doe-b9a38128a"
+<box type="warning">
+
+* You should provide a positive integer that is smaller than the number of contacts stored in CampusConnect for `PERSON_INDEX`.


Should it be smaller than the number of contacts currently listed?

nice catch, the index definitely could be the same as the number of contacts! fixed in b33ffa8

lordidiot · 2023-11-01T15:33:28Z

docs/UserGuide.md


 <box type="warning">

-You are not allowed to edit any alternative contact information, i.e. `TELEGRAM`, `SECONDARY_EMAIL`, `LINKEDIN`, `BIRTHDAY` if any of these fields are empty. You will receive an error message that directs you to use [**`addalt`**](#add-alternative-information-to-contact) command.
+* You should provide a positive integer that is smaller than the number of contacts stored in CampusConnect for `PERSON_INDEX`. 


fixed in b33ffa8

lordidiot · 2023-11-01T15:34:08Z

docs/UserGuide.md

@@ -295,21 +310,41 @@ You are required to input the absolute path to the photo for this command. If yo

 ###  List all contacts: `list`

-Shows a list of all contacts.
+After using CampusConnect's [find contact](#find-contacts) feature that filters the contacts you are looking for, you may want to have an oversight of all your contacts again! Thus, CampusConnect allows you to list all your contacts.


Suggested change

After using CampusConnect's [find contact](#find-contacts) feature that filters the contacts you are looking for, you may want to have an oversight of all your contacts again! Thus, CampusConnect allows you to list all your contacts.

After using CampusConnect's [find contact](#find-contacts) feature that filters the contacts you are looking for, you may want to have an overview of all your contacts again! Thus, CampusConnect allows you to list all your contacts.

I think oversight is the wrong word choice here

fixed in b33ffa8

lordidiot · 2023-11-01T15:34:55Z

docs/UserGuide.md

+
+<box type="warning">
+
+You should provide a positive integer that is smaller than the number of contacts stored in CampusConnect for `PERSON_INDEX`.


fixed inn b33ffa8

lordidiot · 2023-11-01T15:35:38Z

docs/UserGuide.md

@@ -544,16 +579,22 @@ Note that the last example is **not equivalent** to `n/do && t/friend || t/colle
 # Planned Enhancements / Known Issues

 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 executing `addalt` command**, if you input other prefixes that is not accepted by the command format, the error message shown does not prompt you to remove those prefixes and adhere strictly to the command format. We will be working on this in the future to improve the specificity of error messages.


Suggested change

2. **When executing `addalt` command**, if you input other prefixes that is not accepted by the command format, the error message shown does not prompt you to remove those prefixes and adhere strictly to the command format. We will be working on this in the future to improve the specificity of error messages.

2. **When executing `addalt` command**, if you input other prefixes that are not accepted by the command format, the error message shown does not prompt you to remove those prefixes and adhere strictly to the command format. We will be working on this in the future to improve the specificity of error messages.

nice catch of grammatical errors, fixed in b33ffa8

lordidiot · 2023-11-01T15:36:26Z

docs/UserGuide.md

@@ -544,16 +579,22 @@ Note that the last example is **not equivalent** to `n/do && t/friend || t/colle
 # Planned Enhancements / Known Issues

 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 executing `addalt` command**, if you input other prefixes that is not accepted by the command format, the error message shown does not prompt you to remove those prefixes and adhere strictly to the command format. We will be working on this in the future to improve the specificity of error messages.
+3. **When executing `edit` command**, if you try to edit a specified contact to have the same [properties](#properties-of-contact) of another saved contact **(besides `NAME` with the same casing) in your contact list, CampusConnect allows you to do so. We plan to enhance the `edit` command such that it takes into account what makes a contact unique in your contact list.


Wow nice catch

codecov · 2023-11-02T00:15:51Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7b49239) 82.75% compared to head (37e72e5) 82.75%.
Report is 9 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##             master     #140   +/-   ##
=========================================
  Coverage     82.75%   82.75%           
  Complexity      754      754           
=========================================
  Files            99       99           
  Lines          2308     2308           
  Branches        258      258           
=========================================
  Hits           1910     1910           
  Misses          333      333           
  Partials         65       65

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

limjunxian1 · 2023-11-02T04:13:02Z

realised that there is a misinterpretation of the comment on PERSON_INDEX instruction under each warning box, have fixed in 37e72e5

lordidiot

LGTM! Thank you for working on all the changes, very thorough work 👍

limjunxian1 added 2 commits November 1, 2023 22:07

Update UserGuide.md

55bad27

Merge branch 'master' into 1.3b-ug

3724ca2

# Conflicts: # docs/UserGuide.md

limjunxian1 added this to the v1.3b milestone Nov 1, 2023

limjunxian1 requested review from lordidiot and kokrui November 1, 2023 14:43

lordidiot suggested changes Nov 1, 2023

View reviewed changes

Fix grammatical errors

b33ffa8

limjunxian1 added 2 commits November 2, 2023 09:36

Fix style issue

146a13b

Correct instruction mistake

37e72e5

lordidiot approved these changes Nov 2, 2023

View reviewed changes

limjunxian1 merged commit 41bf224 into AY2324S1-CS2103T-T13-2:master Nov 2, 2023
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update UserGuide.md #140

Update UserGuide.md #140

limjunxian1 commented Nov 1, 2023

lordidiot left a comment

lordidiot Nov 1, 2023

limjunxian1 Nov 2, 2023

lordidiot Nov 1, 2023

limjunxian1 Nov 2, 2023

lordidiot Nov 1, 2023

limjunxian1 Nov 2, 2023

lordidiot Nov 1, 2023

limjunxian1 Nov 2, 2023

lordidiot Nov 1, 2023

limjunxian1 Nov 2, 2023

lordidiot Nov 1, 2023

limjunxian1 Nov 2, 2023

lordidiot Nov 1, 2023

limjunxian1 Nov 2, 2023

lordidiot Nov 1, 2023

limjunxian1 Nov 2, 2023

lordidiot Nov 1, 2023

codecov bot commented Nov 2, 2023 •

edited

Loading

limjunxian1 commented Nov 2, 2023

lordidiot left a comment

	* Parameters in square brackets are optional fields, with `addalt` and `edit` as an exception. (Refer to [Add alternative information to contact](#add-alternative-information-to-contact) and [Edit contact information](#edit-contact-information) under Features)<br>
	* Parameters in square brackets are optional, with `addalt` and `edit` as an exception. (Refer to [Add alternative information to contact](#add-alternative-information-to-contact) and [Edit contact information](#edit-contact-information) under Features)<br>

	e.g In `n/NAME [t/TAG]`, `[t/TAG]` is an optional field which can be used as `n/John Doe t/friend` or as `n/John Doe`.
	e.g In `n/NAME [t/TAG]`, `[t/TAG]` is an optional parameter which can be used as `n/John Doe t/friend` or as `n/John Doe`.

	After using CampusConnect's [find contact](#find-contacts) feature that filters the contacts you are looking for, you may want to have an oversight of all your contacts again! Thus, CampusConnect allows you to list all your contacts.
	After using CampusConnect's [find contact](#find-contacts) feature that filters the contacts you are looking for, you may want to have an overview of all your contacts again! Thus, CampusConnect allows you to list all your contacts.


		<box type="warning">

		You should provide a positive integer that is smaller than the number of contacts stored in CampusConnect for `PERSON_INDEX`.

	2. When executing `addalt` command, if you input other prefixes that is not accepted by the command format, the error message shown does not prompt you to remove those prefixes and adhere strictly to the command format. We will be working on this in the future to improve the specificity of error messages.
	2. When executing `addalt` command, if you input other prefixes that are not accepted by the command format, the error message shown does not prompt you to remove those prefixes and adhere strictly to the command format. We will be working on this in the future to improve the specificity of error messages.

Update UserGuide.md #140

Update UserGuide.md #140

Conversation

limjunxian1 commented Nov 1, 2023

lordidiot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Nov 2, 2023 • edited Loading

Codecov Report

limjunxian1 commented Nov 2, 2023

lordidiot left a comment

Choose a reason for hiding this comment

codecov bot commented Nov 2, 2023 •

edited

Loading