diff --git a/docs/UserGuide.md b/docs/UserGuide.md index b3abf0e8722..ebedf185458 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -90,6 +90,20 @@ 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` +### Adding a remark to a person: `remark` + +Edits a remark to an existing person to the address book + +Format: `remark INDEX r/REMARK` + +* Edits the remark for the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …​ +* The previous remark is not saved, and instead is replaced by the inputted remark. The command does not add to the existing remark +* You can empty out a remark by inputting an empty string + +Examples: +* `remark 1 r/Great attitude, hardworking` Edits the remark of the 1st person on the list to have a remark `Great attitude, hardworking` +* `remark 1 r/` Empties the remark of the 1st person. + ### Listing all persons : `list` Shows a list of all persons in the address book. @@ -195,6 +209,7 @@ _Details coming soon ..._ Action | Format, Examples -----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------- **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague` +**Remark** | `remark r/REMARK`
e.g., `remark 1 r/Great attitude, hardworking` **Clear** | `clear` **Delete** | `delete INDEX`
e.g., `delete 3` **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` diff --git a/docs/team/sk2001git.md b/docs/team/sk2001git.md new file mode 100644 index 00000000000..afa7bdef266 --- /dev/null +++ b/docs/team/sk2001git.md @@ -0,0 +1,55 @@ +--- +layout: default.md +title: "Sean Koh's Project Portfolio Page" +--- + +# Project: JABPRO + +## Overview +JABPro aims to solve the problem of HR managers having to sort through tons of job applications. + +It makes their life easier by allowing them to easily fetch important info about job applicants such as their contact details, application status etc. It serves as a one-stop addressbook for job applications. + +## Summary of Contributions +**Code contributed**: [RepoSense link](https://nus-cs2113-ay2021s1.github.io/tp-dashboard/#breakdown=true&search=sk2001git) + +**Enhancement implemented**: +* Remark command + +**Contribution to the UG**: +* Updated UG for the `remark' command + +**Contribution to DG**: +* Contributed to DG for non-functional requirements + +**Contribution to team-based tasks**: +* Keeping track of deadlines and objectives +* Seperating tasks into workable units for team members each week + +**Review/mentoring contributions**: +* Generally main reviewer for PR contributions, requests changes when necessary and not always approving + +**Contributions beyond the project team**: +* + +### Contributions to Developer Guide(Extracts) + + +### Contributions to User Guide(Extracts) + +Adding a remark to a person: `remark` + +Edits a remark to an existing person to the address book + +Format: `remark INDEX r/REMARK` + +* Edits the remark for the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …​ +* The previous remark is not saved, and instead is replaced by the inputted remark. The command does not add to the existing remark +* You can empty out a remark by inputting an empty string + +Examples: +* `remark 1 r/Great attitude, hardworking` Edits the remark of the 1st person on the list to have a remark `Great attitude, hardworking` +* `remark 1 r/` Empties the remark of the 1st person. + + +**Remark** | `remark r/REMARK`
e.g., `remark 1 r/Great attitude, hardworking` diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 00000000000..386de816e07 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,10 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * The settings file is used to specify which projects to include in your build. + * + * Detailed information about configuring a multi-project build in Gradle can be found + * in the user manual at https://docs.gradle.org/7.6/userguide/multi_project_builds.html + */ + +rootProject.name = "tp"