Skip to content

Commit

Permalink
Fix merge conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
lamchenghou committed Nov 14, 2023
2 parents 34f4398 + 7724260 commit e8e4a2e
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 31 deletions.
58 changes: 43 additions & 15 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ note-taking system will assist you in organising your important information you
- 4.6 [Common Classes](#4-6-common-classes)
5. [Implementation](#5-implementation)
- 5.1 [Parser to Handle Commands with Optional Arguments](#5-1-parser-to-handle-commands-with-optional-arguments)
- 5.2 [Listing of Courses, Universities and Notes](#5-2-listing-of-courses-universities-and-notes)
- 5.3 [Adding of Courses, Universities and Notes](#5-3-adding-of-courses-universities-and-notes)
- 5.2 [List Feature](#5-2-list-feature)
- 5.3 [Add Feature](#5-3-add-feature)
- 5.4 [Delete Feature](#5-4-delete-feature)
- 5.5 [Update Feature](#5-5-update-feature)
- 5.6 [Searching of Courses](#5-6-searching-of-courses-universities-and-notes)
- 5.6 [Search Feature](#5-6-search-feature)
- 5.7 [Sort Feature](#5-7-sort-feature)
- 5.8 [Mapping Feature](#5-8-mapping-feature)
6. [Other Helpful Guides](#6-other-helpful-guides)
Expand Down Expand Up @@ -79,6 +79,12 @@ Refer to the guide [_Setting up and getting started_](SettingUp.md).

## 4. Design

This section highlight the design considerations for SEPlendid.

<br>

---

### 4.1 Architecture

<puml src="diagrams/ArchitectureDiagram.puml" width="280" />
Expand Down Expand Up @@ -242,6 +248,9 @@ Classes used by multiple components are in the `seedu.addressbook.commons` packa

This section describes some noteworthy details on how certain features are implemented.

<br>

---
### 5.1 Parser to Handle Commands with Optional Arguments

The below diagram gives a high-level overview on how the `SeplendidParser` parses a command from our command set:
Expand All @@ -251,11 +260,12 @@ The below diagram gives a high-level overview on how the `SeplendidParser` parse

---

### 5.2 Listing of Courses, Universities and Notes
### 5.2 List Feature

**Overview** \
The `list` command generates a list of courses and universities' sample data. This allows the viewing of all the
courses.
#### Overview \
<br>
The `list` command generates a list of SEPlendid data. The data can be in the for of a `localcourse`, `partnercourse`,
`university`, `mapping`, or `note`. This allows the viewing of all the data type that is listed.

The activity diagram is as such:
<puml src="diagrams/ListActivityDiagram.puml" width="100%" />
Expand All @@ -266,7 +276,7 @@ Here is a sequence diagram for `localcourse list`:
<br>
<br>

**Feature Details**
#### Feature Details

1. The user specifies a data object with its required command word.
2. If invalid command arguments are provided, the user will be prompted to enter the command correctly via an
Expand All @@ -277,19 +287,25 @@ Here is a sequence diagram for `localcourse list`:
<br>
<br>

**Feature Considerations**
#### Feature Considerations

Each data type has to be specified to ensure organisation of sample data.

<br>

---

### 5.3 Adding of Courses, Universities and Notes
### 5.3 Add Feature

**Overview** \
The `add` command allows for the adding of new courses, universities and notes. This allows the creation of new
datatypes.
### 5.3 Add Feature

#### Overview
<br>
The `add` command allows for the adding of `localcourse`, `partnercourse`, `mapping` and `notes`. This allows the
addition of new data into SEPlendid.

The activity diagram is as such:
<puml src="diagrams/AddActivityDiagram.puml" width="100%" />
Expand All @@ -305,7 +321,7 @@ Here is a sequence diagram for `partnercourse add`:
<br>
<br>

**Feature Details**
#### Feature Details

1. The user is required to fill up all the attributes require to add the data object.
2. If not all the identity attributes are provided, the user will be prompted to enter the command correctly via an
Expand Down Expand Up @@ -382,9 +398,10 @@ Each data type has different attributes that can be used for updating.

---

### 5.6 Searching of Courses, Universities and Notes
### 5.6 Search Feature

**Overview**
#### Overview
<br>
The `search` command allows users find specific courses or universities they are interested in. This allows for faster
querying of courses, universities and notes.

Expand All @@ -397,7 +414,7 @@ Here is a sequence diagram for `partnercourse search`:
<br>
<br>

**Feature Details**
#### Feature Details

1. The user specifies a data object with its unique identity attribute, attribute that they are querying and the
keyword for the query.
Expand All @@ -412,7 +429,7 @@ Here is a sequence diagram for `partnercourse search`:
<br>
<br>

**Feature Considerations**
#### Feature Considerations
The data object is only searched when all the specified identity attributes are identical to the existing data object.
Each data type has different attributes that can be used for searching.

Expand Down Expand Up @@ -539,6 +556,12 @@ non-empty, the deletion will be performed, otherwise a `CommandException` will b

## 7. Requirements

This section highlight the requirements that were considered when creating SEPlendid.

<br>

---

### 7.1 Product Scope

**Target user profile**:
Expand Down Expand Up @@ -1560,8 +1583,13 @@ This section describes the planned enhancements for SEPlendid.
The implementation of SEPlendid proved to be a challenging endeavor. Below is the highlights of the extensive effort our
team dedicated to developing SEPlendid, along with a mention of some of the challenges we encountered along the way.

<br>

---

### 10.1 Morphing of AB3 to SEPlendid


As mappings was the core feature of SEPlendid, we decided to morph AB3 into SEPlendid. We identified the need for
several data types, minimally `LocalCourse`, `PartnerCourse`, `University` and `Mapping`. We also identified the
unique identifiers for each data type, and the relationships between them. For instance, a `Mapping` object has a
Expand Down
3 changes: 2 additions & 1 deletion docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -872,10 +872,11 @@ Adds a note with the content you wish to add and the tag you wish your note to h
**Format:** `note add [content] [tag]`


<box type="info" icon=":information-source">
<box type="info" icon=":information_source">
Tag must only be a single word with no whitespaces and only contain alphabets and numbers. You can only add 1 tag
for your note with this command.
If you wish to have more tags for your note, you can do so with the command <code>note tag</code>.
You cannot have two notes of the same content.
</box>

**Example:** `note add [You can do this!] [motivation]`
Expand Down
28 changes: 13 additions & 15 deletions docs/team/alyssaongyx.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,18 @@ universities and course mappings. The application is also bundled with many othe

Given below are my contributions to the project.

* * **New Feature**: Added the ability to search for localcourses, partnercourses and universities.
* * **New Feature**: Added the ability to search for localcourses, partnercourses and universities. [#156,#105](https://github.com/AY2324S1-CS2103T-W10-2/tp/pull/156)
* What it does: This feature allows the user to query for courses and universities they are interested in.
* Justification: This feature improves the product significantly because a user may wish to find the course or
university they are interested in. The app will narrow down the search and allow for more easy retrieving and
viewing of the results.

* * **New Feature**: Added the ability to update for localcourses
* * **New Feature**: Added the ability to update for localcourses [#195](https://github.com/AY2324S1-CS2103T-W10-2/tp/pull/195)
* What it does: This feature allows the user to sort localcourses by its attributes - localcode and localname.
* Justification: This feature improves the product because a user will be able to view the courses in order,
organising the large number of sample data.

* * **New Feature**: Added the ability to list universities
* * **New Feature**: Added the ability to list universities [#79](https://github.com/AY2324S1-CS2103T-W10-2/tp/pull/79)
* What it does: This feature allows the user to retrieve all the information of universities.
* Justification: This feature allows the user to view all the universities offered by NUS Computing, allowing them to
choose and research on the universities they are interested in.
Expand All @@ -36,8 +36,7 @@ Given below are my contributions to the project.
* Review and merge PRs

* **Enhancements to existing features**:
* Updated the GUI color scheme (Pull requests [\#33](), [\#34]())
* Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]())
* Wrote additional tests for existing features to increase coverage from 76% to 81% (Pull requests [\#36](), [\#38]())

* **Documentation**:
* User Guide:
Expand All @@ -49,19 +48,18 @@ Given below are my contributions to the project.
* Added the Quick Reference Guide section
* Added the Introduction section
* Edited the command summary section to add note's `cleartag` feature
* Fix documentation bugs in the User Guide
* Add description for each feature in the User Guide
* Fix documentation bugs in the User Guide [#297](https://github.com/AY2324S1-CS2103T-W10-2/tp/pull/297)
* Add description for each feature in the User Guide [#242](https://github.com/AY2324S1-CS2103T-W10-2/tp/pull/242)
* Developer Guide:
* Added implementation details of the `list` feature.
* Added implementation details of the `add` feature.
* Added implementation details of the `delete` feature.
* Added the activity diagrams and sequence diagrams for the aforementioned features. [\#280](https://github.com/AY2324S1-CS2103T-W10-2/tp/pull/280)

* **Community**:
* PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]()
* Contributed to forum discussions (examples: [1](), [2](), [3](), [4]())
* Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]())
* Some parts of the history feature I added was adopted by several other class mates ([1](), [2]())

* **Tools**:
* Integrated a third party library (Natty) to the project ([\#42]())
* Integrated a new Github plugin (CircleCI) to the team repo
* PRs reviewed (with non-trivial review comments): [\#115](https://github.com/AY2324S1-CS2103T-W10-2/tp/pull/115),
[\#157](https://github.com/AY2324S1-CS2103T-W10-2/tp/pull/157)
* Reported bugs and suggestions for other teams in the class (examples: [15](https://github.com/alyssaongyx/ped/issues/15)


* _{you can add/remove categories in the list above}_

0 comments on commit e8e4a2e

Please sign in to comment.