From f89dce0806c89cd7be905f282c5943640fc70b4a Mon Sep 17 00:00:00 2001 From: tjingsheng Date: Tue, 14 Nov 2023 11:39:16 +0800 Subject: [PATCH 1/5] Initial refactoring of header and abit of content --- docs/DeveloperGuide.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index a650605af7d..940ad2d9f84 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -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) @@ -248,11 +248,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. +
+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: @@ -282,11 +283,12 @@ Each data type has to be specified to ensure organisation of sample data. --- -### 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. +
+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: @@ -379,9 +381,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** +
The `search` command allows users find specific courses or universities they are interested in. This allows for faster querying of courses, universities and notes. From e403a7329c0f5dcb926f86349df87f408c08a58e Mon Sep 17 00:00:00 2001 From: tjingsheng Date: Tue, 14 Nov 2023 11:41:37 +0800 Subject: [PATCH 2/5] Standardise subheaders of features --- docs/DeveloperGuide.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 940ad2d9f84..6f94fe8f386 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -250,7 +250,7 @@ The below diagram gives a high-level overview on how the `SeplendidParser` parse ### 5.2 List Feature -**Overview** +#### Overview
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. @@ -264,7 +264,7 @@ Here is a sequence diagram for `localcourse list`:

-**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 @@ -275,7 +275,7 @@ Here is a sequence diagram for `localcourse list`:

-**Feature Considerations** +#### Feature Considerations Each data type has to be specified to ensure organisation of sample data. @@ -285,7 +285,7 @@ Each data type has to be specified to ensure organisation of sample data. ### 5.3 Add Feature -**Overview** +#### Overview
The `add` command allows for the adding of `localcourse`, `partnercourse`, `mapping` and `notes`. This allows the addition of new data into SEPlendid. @@ -304,7 +304,7 @@ Here is a sequence diagram for `partnercourse add`:

-**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 @@ -383,7 +383,7 @@ Each data type has different attributes that can be used for updating. ### 5.6 Search Feature -**Overview** +#### Overview
The `search` command allows users find specific courses or universities they are interested in. This allows for faster querying of courses, universities and notes. @@ -397,7 +397,7 @@ Here is a sequence diagram for `partnercourse search`:

-**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. @@ -412,7 +412,7 @@ Here is a sequence diagram for `partnercourse search`:

-**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. @@ -520,7 +520,6 @@ non-empty, the deletion will be performed, otherwise a `CommandException` will b * Cons: We must ensure that deletion cascades, in order to maintain data integrity. This can introduce bugs if not done correctly. -
--- From e28d8508055afd7bc379d3b99f813eb88ef13ffa Mon Sep 17 00:00:00 2001 From: tjingsheng Date: Tue, 14 Nov 2023 11:55:58 +0800 Subject: [PATCH 3/5] Standardise page separators --- docs/DeveloperGuide.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 6f94fe8f386..1f94d5ed2c1 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -77,6 +77,12 @@ Refer to the guide [_Setting up and getting started_](SettingUp.md). ## 4. Design +This section highlight the design considerations for SEPlendid. + +
+ +--- + ### 4.1 Architecture @@ -239,6 +245,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. +
+ +--- ### 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: @@ -538,6 +547,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. + +
+ +--- + ### 7.1 Product Scope **Target user profile**: @@ -1549,6 +1564,10 @@ Expected Output in the Command Output Box: Note searched message. 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. +
+ +--- + ### 9.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 From 2dcd8d15653b593f8446a8a3c39ccd5f711c40d0 Mon Sep 17 00:00:00 2001 From: alyssaongyx Date: Tue, 14 Nov 2023 12:17:09 +0800 Subject: [PATCH 4/5] Update PPP --- docs/team/alyssaongyx.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/docs/team/alyssaongyx.md b/docs/team/alyssaongyx.md index 6c7fc0322fe..a7851a87614 100644 --- a/docs/team/alyssaongyx.md +++ b/docs/team/alyssaongyx.md @@ -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. @@ -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: @@ -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}_ From 019f60b8ef372c2174f344a0332fda18d244e5a7 Mon Sep 17 00:00:00 2001 From: dlathyun Date: Tue, 14 Nov 2023 12:19:43 +0800 Subject: [PATCH 5/5] Fix errors --- docs/UserGuide.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 0a1a85b2a5f..15cf6748807 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -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]` - + 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 note tag. + You cannot have two notes of the same content. **Example:** `note add [You can do this!] [motivation]`