Skip to content

Commit 9e6ddf7

Browse files
authored
Merge pull request #230 from shaunlxw/dg/planned-enhancements
Add planned enhancements
2 parents eb3af84 + 10acdc8 commit 9e6ddf7

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/DeveloperGuide.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -613,6 +613,18 @@ _{more aspects and alternatives to be added}_
613613

614614
--------------------------------------------------------------------------------------------------------------------
615615

616+
## **Appendix: Planned Enhancements**
617+
618+
Team size: 5
619+
620+
1. **Make `showrelated` command output a specific error message when an `ID` that does not exist is provided:** Currently, when input is `showrelated i/10` but there is no `Person` with `ID` 10, the command succeeds and outputs the message "0 persons listed!". This is not the expected result, as the command should fail with an appropriate error message. We plan to handle this erroneous input, and show the error message: "There is no person with id 10" for the above command.
621+
1. **Make `relate` command success message more specific:** The current message for a successful `relate i/1 i/2` command only shows "2 persons listed!", which is too general and might not catch user's typos or mistakes if they wanted to do `relate i/1 i/3 instead`. We plan to make the success message output the two persons that are involved in the `relate` command: "The relation between these two persons have been created: `Alex Yeoh, Phone: 87438807, Email:alexyeoh@example.com` and `Bernice Yu, Phone: 99272758, Email: berniceyu@example.com`".
622+
1. **Fix input validation for `relate` and `unrelate` command:** Currently, the commands `relate i/ 1 i/ 2 `, `relate i/1 2 i/3`, `relate i/1 i/2 tag/friends`, or `relate i/a 1 i/2` will fail with the following error message: "Invalid command format! ...". This is not consistent with the other commands that ignores additional whitespaces provided to arguments, invalid prefixes provided, or invalid id. We plan to accept values with trailing and leading whitespaces in `relate` and `unrelate` command, and output specific error message for invalid prefixes and invalid id.
623+
1. **Enhance UI to wrap long text:** Current implementation of NetConnect GUI is only able to accommodate input of approximately 120 characters for the profile fields (name, tags, etc.) in fullscreen mode. Additional text are represented by ellipsis. We plan to enhance the UI to wrap text responsively according to the screen size in the GUI and input length to prevent truncation of text.
624+
1. **Make `edit` command output a specific error message when the given values of fields are the same as existing ones:** Currently, when input is `edit i/1 n/Alex` but `Person` with `ID` 1 already has the name `Alex`, the command succeeds and outputs the message: "Edited Person: ..." although no values were actually changed since the same value is provided. We plan to handle this case where same values are given, making the command fail and show the error message: "There are no changes to values provided".
625+
1. **Add soft delete and data recovery feature:** Currently, our id is used in a strictly increasing order, i.e. after deletion of person with `ID` 6, there will be no other persons allowed to have `ID` 6 in the same run of the app. The rationale for this implementation is to facilitate the feature of soft delete and data recovery. Soft delete means that we will not completely remove the deleted `Person` and the details from NetConnect, but only mark it as deleted and not display it or use in any other commands. Soft delete will facilitate the data recovery feature, for user to recover the details of a deleted `Person` in the event of accidental deletion.
626+
1. **Make `unrelate` command success message more user-friendly:** The current success message for the command `unrelate i/1 i/2` shows "Unrelated the following persons: 1relates2", which is not very user friendly. We plan to change the command success message to show: "Unrelated the following persons: `Alex Yeoh, Phone: 87438807, Email:alexyeoh@example.com` and `Bernice Yu, Phone: 99272758, Email: berniceyu@example.com`"
627+
616628
## **Appendix: Requirements**
617629

618630
### Product scope

0 commit comments

Comments
 (0)