Skip to content

Commit

Permalink
Merge pull request #277 from Chandan8186/br-final-fixes
Browse files Browse the repository at this point in the history
Make small fixes to UG and DG
  • Loading branch information
rayyan35p authored Nov 14, 2023
2 parents 75ffc0f + 5bb9f1a commit b4c567c
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 21 deletions.
16 changes: 12 additions & 4 deletions docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: About Us

We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).

You can reach us at the email `seer[at]comp.nus.edu.sg`
You can reach us at the email `chandan_ab@u.nus.edu`

## Project team

Expand All @@ -17,6 +17,8 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
[[portfolio](team/antontan96.md)]

* Role: Developer
* Responsibilities:
* Co-ordinate product design

### Aslam

Expand All @@ -26,17 +28,19 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
[[portfolio](team/aslam341.md)]

* Role: Developer
* Responsibilities: Features
* Responsibilities:
* Ensure code quality, standard and correctness

### Chandan

<img src="images/chandan8186.png" width="200px">

[[github](http://github.com/Chandan8186)]
[[portfolio](team/chandan8186.md)]
[[email](mailto:[email protected])]

* Role: Developer
* Responsibilities:
* Manage and verify product releases

### Rayyan Ismail

Expand All @@ -46,6 +50,8 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
[[portfolio](team/rayyan35p.md)]

* Role: Developer
* Responsibilities:
* Ensure team meets deadlines for deliverables

### Timothy Leow

Expand All @@ -55,4 +61,6 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
[[portfolio](team/timleow.md)]

* Role: Developer
* Responsibilities: Implement Help Pop-Up and updating User profile, value proposition in Developer Guide
* Responsibilities:
* Manage bug triaging

31 changes: 17 additions & 14 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,6 @@ The `Project` component stores a project's data which comprises:
* The `TaskList` contains the `Task`s which have been added to the `Project`.
* The `Employee` (if applicable) in each `Task` in the `TaskList` of the project must also exist in the `UniqueEmployeeList` of the project.

***Note: For the Model, Employee and Project components, lower-level details (e.g. most class attributes and methods) have been omitted for visual clarity.


### Task component
**API** : [`Task.java`](https://github.com/AY2324S1-CS2103T-T08-3/tp/blob/master/src/main/java/seedu/address/model/task/Task.java)
Expand All @@ -180,7 +178,7 @@ The `Task` component stores a task's data which comprises:

<div markdown="span" class="alert alert-info">

:information_source: **Note:** The `Employee`, `Project` and `Task` class diagrams above have omitted some details (e.g. class methods) to improve visual clarity. Only the most important fields and associations are shown.
:information_source: **Note:** The `Model`, `Employee`, `Project` and `Task` class diagrams above have omitted some details (e.g. class methods) to improve visual clarity. Only the most important fields and associations are shown.

</div>

Expand Down Expand Up @@ -677,23 +675,28 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

* 2b. User does not enter at least one field to edit.
* 2b. User does not enter a valid index for the project.
* 2b1. TaskHub shows an error message.

Use case ends.

* 2c. User enters an invalid value for a field.
* 2c. User does not enter at least one field to edit.
* 2c1. TaskHub shows an error message.

Use case ends.

* 2d. User edits the project's name to one that already exists.
* 2d. User enters an invalid value for a field.
* 2d1. TaskHub shows an error message.

Use case ends.

* 2e. User enters multiple values for a single-valued field.
* 2e. User edits the project's name to one that already exists.
* 2e1. TaskHub shows an error message.

Use case ends.

* 2f. User enters multiple values for a single-valued field.
* 2f1. TaskHub shows an error message.

Use case ends.

Expand Down Expand Up @@ -1178,7 +1181,7 @@ This use case is also applicable to editing **priority** of multiple projects.

Use case ends.

**Use case: UC24 - Clear all data **
**Use case: UC24 - Clear all data**

**MSS**

Expand All @@ -1188,7 +1191,7 @@ This use case is also applicable to editing **priority** of multiple projects.

Use case ends.

**Use case: UC25 - Exit the application **
**Use case: UC25 - Exit the application**

**MSS**

Expand Down Expand Up @@ -1670,9 +1673,9 @@ Nonetheless, we plan to add an error message to be displayed to the user saying

Building TaskHub was of moderate to high difficulty for our team due to the following reasons:

- we had to build on top of an existing, brownfield project, the codebase of which we were not familiar with
- it was our first time working with Java and JavaFX in a software engineering context
- we created two more model components (`Project`s and `Task`s) with dependencies among each other and with `Employee`s
- We had to build on top of an existing, brownfield project, the codebase of which we were not familiar with
- It was our first time working with Java and JavaFX in a software engineering context
- We created two more model components (`Project`s and `Task`s) with dependencies among each other and with `Employee`s

### **Challenges Faced**

Expand Down
4 changes: 2 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -576,7 +576,7 @@ Format: `listE`
Finds employees whose names contain any of the given keywords.
Additionally, it shows only the projects that these employees are under.
Format: `findE KEYWORD [MORE_KEYWORDS]`
Format: `findE KEYWORD [MORE_KEYWORDS]…​`
* The search is case-insensitive. e.g. `hans` will match `Hans`
* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
Expand Down Expand Up @@ -784,7 +784,7 @@ Format: `listP`
Find projects whose names contain any of the given keywords.
Additionally, it shows only the employees that are under these projects.
Format: `findP KEYWORD [MORE_KEYWORDS]`
Format: `findP KEYWORD [MORE_KEYWORDS]…​`
* The search is case-insensitive. e.g. `website` will match `Website`
* The order of the keywords does not matter. e.g. `Create Website` will match `Website Create`
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/seedu/address/MainApp.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
*/
public class MainApp extends Application {

public static final Version VERSION = new Version(1, 3, 2, true);
public static final Version VERSION = new Version(1, 4, 0, true);

private static final Logger logger = LogsCenter.getLogger(MainApp.class);

Expand Down

0 comments on commit b4c567c

Please sign in to comment.