Update UG on introduction and command 'add' #13
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 Report
@@ Coverage Diff @@
## master #13 +/- ##
=========================================
Coverage 75.26% 75.26%
Complexity 419 419
=========================================
Files 71 71
Lines 1338 1338
Branches 126 126
=========================================
Hits 1007 1007
Misses 301 301
Partials 30 30 |
Closed
tanyyyming
approved these changes
Oct 5, 2023
Comment on lines
-75
to
+109
| ### Adding a person: `add` | ||
| ### Adding a musician contact: `add` | ||
|
|
||
| Adds a person to the address book. | ||
| Adds a musician to the contact book. Name, phone number and email can be recorded. | ||
|
|
||
| Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…` | ||
| **Format:** `add n/NAME p/PHONE_NUMBER e/EMAIL` | ||
|
|
||
| <div markdown="span" class="alert alert-primary">:bulb: **Tip:** | ||
| A person can have any number of tags (including 0) | ||
| </div> | ||
| **Examples:** | ||
| * `add n/John Doe p/98928479 e/johndpiano@xmail.com` | ||
| * `add n/Betsy Crowe e/violinistbetsy@smtp.com p/87988039` | ||
|
|
||
| Examples: | ||
| * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` | ||
| * `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal` | ||
| **Upon success:** | ||
|
|
||
| You will see a message indicating successful addition of the musician like below: | ||
| [insert image] | ||
|
|
||
| **Upon failure:** | ||
|
|
||
| Should you input a musician which is already in your contact book(ie. have the same phone number or email as an existing contact), you will see a message like below, please input a different phone/email for the current contact or modify the original contact's relevant details. | ||
|
|
||
| [insert image] |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updated the 'welcome message', 'table of contents', 'about this guide' sections of the UG. Laid out a rough structure of the UG in the table of contents section based on CS2101 Revisiting UG slides. Updated the add command section for the first user story.