This repository has been archived by the owner on Apr 6, 2024. It is now read-only.
Fix UserGuide.md as per PED suggestions #209
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #209 +/- ##
=========================================
Coverage 82.50% 82.50%
Complexity 753 753
=========================================
Files 99 99
Lines 2327 2327
Branches 261 261
=========================================
Hits 1920 1920
Misses 339 339
Partials 68 68
☔ View full report in Codecov by Sentry. |
lordidiot
approved these changes
Nov 8, 2023
docs/UserGuide.md
Outdated
| @@ -54,16 +54,14 @@ Our guide uses **visual components** to highlight key information for your conve | |||
| <div> | |||
| <br> | |||
| <panel header=":fa-solid-book: **Command Parameter / Syntax Tables**" type="secondary" expanded no-close> | |||
| Large tables describing the **syntax or parameters** of **parameter-heavy commands**, or the **attributes of large models**, will be contained in a **collapsible grey panel** like this one with a **book icon** :fa-solid-book:. | |||
| This **collapsible grey panel** with the **book icon** contains large tables that describes the **syntax or parameters** of **parameter-heavy commands**, or the **attributes of large models** such as our [Person model](DeveloperGuide.md#model-component). | |||
There was a problem hiding this comment.
Suggested change
| This **collapsible grey panel** with the **book icon** contains large tables that describes the **syntax or parameters** of **parameter-heavy commands**, or the **attributes of large models** such as our [Person model](DeveloperGuide.md#model-component). | |
| This collapsible grey panel with the **book icon** contains large tables that describes the **syntax or parameters** of parameter-heavy commands, or the **attributes of large models** such as our [Person model](DeveloperGuide.md#model-component). |
Would recommend unbolding these things so that the bolding for the other terms is more effective. Right now there is a feeling that everything is bolded.
| @@ -192,24 +191,24 @@ All planned enhancements will also be listed in the [Planned Enhancements / Know | |||
| * If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. | |||
| </box> | |||
|
|
|||
| ## Manage Contacts | |||
| ## Contact Management | |||
docs/UserGuide.md
Outdated
|
|
||
| <box type="info" icon=":fa-solid-magnifying-glass:"> | ||
|
|
||
| Below are some examples on how to use the command: | ||
|
|
||
| * `edit 1 tg/@johndoe e2/[email protected]`: Edits telegram to "@johndoe" and secondary email to "[email protected]" for contact at index 1 of your contact list. | ||
| * `edit 2 n/Betsy e/[email protected] a/Newgate Heavan p/98765411 t/bestfriend`: Edits name to "Besty", email to "[email protected]", address to "Newgate Heavan", phone to "98765411" and tag to "bestfriend" for contact at index 2 of your contact list. | ||
| * `edit 3 t/` Removes all existing tags for contact at index 3 of your contact list. <br> **Note: In this case, for the parameter `[t/TAG]`, you can only input once if you will like to remove all existing tags of your contact, e.g. `edit 3 t/ t/` will not work.** |
There was a problem hiding this comment.
Suggested change
| * `edit 3 t/` Removes all existing tags for contact at index 3 of your contact list. <br> **Note: In this case, for the parameter `[t/TAG]`, you can only input once if you will like to remove all existing tags of your contact, e.g. `edit 3 t/ t/` will not work.** | |
| * `edit 3 t/` Removes all existing tags for contact at index 3 of your contact list. <br> **Note: In this case, for the `[t/TAG]` parameter, you can only input it once if you want to remove all existing tags from your contact, e.g. `edit 3 t/ t/` will not work.** |
Consider rephrasing this like so.
There was a problem hiding this comment.
this phrasing sounds better! fixed in 255e904
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #163, closes #168, closes #192
This PR also: