Skip to content

Commit

Permalink
Merge pull request #19 from sk2001git/master
Browse files Browse the repository at this point in the history
Updated UG for remark which is adding optional comments
  • Loading branch information
sk2001git committed Oct 3, 2023
2 parents 13aade6 + 869f2c9 commit dd7c2fb
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,20 @@ Examples:
* `add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01`
* `add n/Betsy Crowe t/friend e/[email protected] 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.
Expand Down Expand Up @@ -195,6 +209,7 @@ _Details coming soon ..._
Action | Format, Examples
-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------
**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague`
**Remark** | `remark r/REMARK` <br> e.g., `remark 1 r/Great attitude, hardworking`
**Clear** | `clear`
**Delete** | `delete INDEX`<br> e.g., `delete 3`
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
Expand Down
55 changes: 55 additions & 0 deletions docs/team/sk2001git.md
Original file line number Diff line number Diff line change
@@ -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` <br> e.g., `remark 1 r/Great attitude, hardworking`
10 changes: 10 additions & 0 deletions settings.gradle.kts
Original file line number Diff line number Diff line change
@@ -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"

0 comments on commit dd7c2fb

Please sign in to comment.