-
Notifications
You must be signed in to change notification settings - Fork 263
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[CS2103T-W16-3] StudyBuddy #55
base: master
Are you sure you want to change the base?
[CS2103T-W16-3] StudyBuddy #55
Conversation
docs/DeveloperGuide.adoc
Outdated
@@ -297,33 +297,32 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un | |||
|Priority |As a ... |I want to ... |So that I can... | |||
|`* * *` |new user |see usage instructions |refer to instructions when I forget how to use the App | |||
|
|||
|`* * *` |user |add a new person | | |||
|`* * *` |user |add a new task | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
By removing persons object from your project, does this mean that there's no longer a address book functionality at all?
docs/DeveloperGuide.adoc
Outdated
@@ -347,7 +346,7 @@ _{More to be added}_ | |||
== Non Functional Requirements | |||
|
|||
. Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `11` or above installed. | |||
. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage. | |||
. Should be able to hold up to 1000 tasks without a noticeable sluggishness in performance for typical usage. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
noticeable sluggishness should be quantified (e.g 300ms or smth)
@@ -297,33 +297,32 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un | |||
|Priority |As a ... |I want to ... |So that I can... | |||
|`* * *` |new user |see usage instructions |refer to instructions when I forget how to use the App | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can filtering searches be added as a user story?
@@ -347,7 +346,7 @@ _{More to be added}_ | |||
== Non Functional Requirements | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any more NFRs to add? e.g. should be NUS student, response time of system
docs/DeveloperGuide.adoc
Outdated
@@ -347,7 +346,7 @@ _{More to be added}_ | |||
== Non Functional Requirements | |||
|
|||
. Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `11` or above installed. | |||
. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage. | |||
. Should be able to hold up to 1000 tasks without a noticeable sluggishness in performance for typical usage. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
need to be more specific about what is a noticeable sluggishness
Please retitle the PR with the correct format. |
Section 3.1.2
Section 3.2.1
Generally clear and understandable, but perhaps having at least one class diagram for your modules such as Calendar or the Due Soon Task feature would enhance the comprehensiveness of your DG :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, there were some flaws in the UML diagrams.
@@ -98,39 +123,34 @@ image::LogicClassDiagram.png[] | |||
*API* : |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the logic component diagram, it seems like a lot of things were changed (e.g. ArgumentMultimap, Tokenizer) but from what I've seen from the codebase, those classes seems to be still there. Is this intended?
Also, there is no interaction between the logic class and parser class, which is a little weird because typically they are related to one another.
docs/DeveloperGuide.adoc
Outdated
|
||
NOTE: The lifeline for `UndoCommand` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram. | ||
image::DueSoonSequenceDiagram.png[width = "600", length = "500"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-
Is the group still using AddressBook model? If not, remember to remove it / rename it appropriately from your sequence diagram!
-
Also, is there any arguments taken in by the functions? E.g. execute(), addDueSoonTask
-
For the cross that indicates a deletion, remember to place it a further ahead (not directly on the end of the lifeline bar)
-
Consider color coding the different sections (e.g. model, logic, ui) for better readability
docs/DeveloperGuide.adoc
Outdated
Activity diagram for step 4: | ||
|
||
image::TaskSummaryWithRefreshCommandActivityDiagram.png[width = "400", length = "600"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The conditions that come after "find any task with expired status" should be more explicit, maybe you can consider [has expired status], [else].
Also, remember to join the node back after your conditions are executed.
docs/DeveloperGuide.adoc
Outdated
|
||
Activity diagram: | ||
|
||
image::CalendarActivityDiagram.png[width = "400", length = "600"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe the command box for (day < Month.length) is not compliant with the activity diagram we were taught? Also, the if else condition should have square bracket.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall good ideas, but maybe your implementation could be done with a bit more consideration and more detailed documentation!
docs/DeveloperGuide.adoc
Outdated
@@ -79,15 +81,38 @@ image::UiClassDiagram.png[] | |||
|
|||
*API* : link:{repoURL}/src/main/java/seedu/address/ui/Ui.java[`Ui.java`] | |||
|
|||
The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `PersonListPanel`, `StatusBarFooter` etc. All these, including the `MainWindow`, inherit from the abstract `UiPart` class. | |||
The UI consists of a `MainWindow` that is made up of parts e.g.`BrandingLabel`, `TaskListPanel`, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider changing the name of the classes at least to make them consistent with your application (from Person
to Task
)
As a more OOP model, we can store a `Tag` list in `Address Book`, which `Person` can reference. This would allow `Address Book` to only require one `Tag` object per unique `Tag`, instead of each `Person` needing their own `Tag` object. An example of how such a model may look like is given below. + | ||
+ | ||
image:BetterModelClassDiagram.png[] | ||
|
||
[[Design-Storage]] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similarly, change class names here as well to make it consistent!
docs/DeveloperGuide.adoc
Outdated
|
||
Step 1. The user launches the application for the first time. The `VersionedAddressBook` will be initialized with the initial address book state, and the `currentStatePointer` pointing to that single address book state. | ||
Command: add |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should add the syntax of the command instead of just the command word itself, e.g.: add n/ NAME t/ [TAG]...
docs/DeveloperGuide.adoc
Outdated
image::UndoRedoState4.png[] | ||
Step 1. The user launches the application with some alive and archived task records in the `storage`. | ||
Statistics will perform on the records retrieved, and the result will be visualized as different charts organized in a `tab panel`. | ||
After the user clicks `Statistics -> Task Summary`, the `tab panel` will display. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This might not be complying to the project requirement of CLI? is there a CLI command for this?
docs/DeveloperGuide.adoc
Outdated
|
||
The task summary feature allows user to enjoy visualized and real-time statistics of their tasks' information. | ||
|
||
This feature is implemented using different charts as `pie chart`, `area chart`, `bar chart` and `line chart`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure how these charts are implemented, are they new classes or just some attributes? maybe for OOP, implement them as new classes and reflect that in model?
docs/DeveloperGuide.adoc
Outdated
** Pros: Will use less memory (e.g. for `delete`, just save the person being deleted). | ||
** Cons: We must ensure that the implementation of each individual command are correct. | ||
==== Implementation | ||
The calendar feature, as the name suggests, displays a calendar fo users. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo here at "fo" 😢
docs/DeveloperGuide.adoc
Outdated
. Displays the name of all tasks on that day in the calendar grid. | ||
. Access calendars in previous or next month using the buttons on top. | ||
. Displays more information about tasks for the day on the due soon panel after clicking on a grid. (Not done) | ||
. Fast forward to a specific year/month using CLI. (Not done) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same concern here about CLI
…nto calendar_command
Updated duplicate feature + documentation
… into calendar_command
Calendar command
Small change in DG
complete uml writeup
DG update
rename ppp
# Conflicts: # docs/DeveloperGuide.adoc # docs/UserGuide.adoc
PPP and DG update
about us add portfolio for all
merge from team repo
- bug fix for due soon tag - bug fix for add module - exception update - UG update
The pull request for Team W16-3