forked from nus-cs2103-AY1819S2/addressbook-level4
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #55 from ZhangJiayu0303/master
Updated the developer guide for enhanced add command
- Loading branch information
Showing
1 changed file
with
21 additions
and
1 deletion.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -383,6 +383,26 @@ We are using `java.util.logging` package for logging. The `LogsCenter` class is | |
|
||
Certain properties of the application can be controlled (e.g user prefs file location, logging level) through the configuration file (default: `config.json`). | ||
|
||
|
||
=== Three new attributes: Salary, Occupation, Relationship | ||
==== Current Implementation | ||
The add Command is modified in this enhancement. Previously, user can only add a person's name, phone number, address and tags to the address book. | ||
After this enhancement, following attributes are added to the person's information: | ||
|
||
* `SALARY`: salary must be a string with more than one digits | ||
* `OCCUPATION`: occupation can be a string with any characters | ||
* `RELATIONSHIP`: relationship must be a string with one word (no blank allowed) | ||
|
||
===== How to implement the command | ||
Users just input: | ||
add n/NAME p/PHONE e/EMAIL a/ADDRESS s/SALARY o/OCCUPATION r/RELATIONSHIP [t/TAG] | ||
Example: add n/John Doe p/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25 s/100000o/bankerr/singlet/friends t/owesMoney | ||
|
||
|
||
===== Pros and Cons | ||
** Pros: Easy to implement, and the add format just follows the previous version | ||
** Cons: When implementing add Command, Users must add all information except the optional TAG attribute, this makes the command not flexible enough | ||
|
||
== Documentation | ||
|
||
We use asciidoc for writing documentation. | ||
|
@@ -872,7 +892,7 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un | |
|Priority |As a ... |I want to ... |So that I can... | ||
|`* * *` |new user |see usage instructions |refer to instructions when I forget how to use the App | ||
|
||
|`* * *` |user |add a new person | | ||
|`* * *` |user |add a new person | name, phone, address, salary, occupation, relationship, tags (optional) | ||
|
||
|`* * *` |user |delete a person |remove entries that I no longer need | ||
|
||
|