Skip to content

[CS2113-W13-2] CLI-nton#85

Open
NicholasTanYY wants to merge 682 commits into
nus-cs2113-AY2324S2:masterfrom
AY2324S2-CS2113-W13-2:master
Open

[CS2113-W13-2] CLI-nton#85
NicholasTanYY wants to merge 682 commits into
nus-cs2113-AY2324S2:masterfrom
AY2324S2-CS2113-W13-2:master

Conversation

@NicholasTanYY

Copy link
Copy Markdown

Simplifies life by providing a fast and straightforward way for users to manage tasks, stay informed with news, and check the weather—all within a command-line environment, ensuring a seamless and productive user experience.

@cirelesna cirelesna left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DG review

Comment thread docs/DeveloperGuide.md Outdated

## Data Component
### API: [Data](https://github.com/AY2324S2-CS2113-W13-2/tp/tree/master/src/main/java/data)
![Data Class Diagram](images/class/Data.png)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could the visual be split up into smaller parts?
image

Comment thread docs/DeveloperGuide.md Outdated
Comment on lines +471 to +474
| Version | As a ... | I want to ... | So that I can ... |
|---------|----------|---------------------------|-------------------------------------------------------------|
| v1.0 | new user | see usage instructions | refer to them when I forget how to use the application |
| v2.0 | user | find a to-do item by name | locate a to-do without having to go through the entire list |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could there be more user stories for v1.0 and v2.0?

Comment thread docs/DeveloperGuide.md Outdated
Comment on lines +199 to +207
### How it works:
1. When the program starts, a TaskManager instance is created.
2. Saved tasks are retrieved by interfacing with the Storage class to create required tasks and save them to this
instance of TaskManager.
3. When the user requests an operation, the main function parses the input and hands it to TaskManager if it is related
4. The TaskManager will handle all requests relating to tasks, using methods detailed in the following sections.
to tasks.
5. The TaskManager will also create INFO-level logs when making changes to tasks.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could a sequence diagram illustrate how it works better?

Comment thread docs/DeveloperGuide.md
## Storage component
**API** : [Storage.java](https://github.com/AY2324S2-CS2113-W13-2/tp/blob/master/src/main/java/storage/Storage.java)

The 'storage' component:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could a class diagram be used here?

Comment thread docs/DeveloperGuide.md Outdated

The `Main` class is responsible for handling user input and dispatching commands to the appropriate components. It manages the switching between the week and month views based on the user's input.

When the user enters the `month` command, the `Main` class toggles the `inMonthView` flag and calls the `printView` method of the `MonthView` instance, rendering the month view. Similarly, when the user enters the `week` command, the `Main` class sets the `inMonthView` flag to `false` and calls the `printView` method of the `WeekView` instance, rendering the week view.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

inconsistent formatting when compared to other sections of the developer's guide. Other sections utilised bullet points to convey the necessary information while this section conveyed all of its points in a paragraph.

Comment thread docs/DeveloperGuide.md Outdated
Comment on lines +24 to +25
### API: [Data](https://github.com/AY2324S2-CS2113-W13-2/tp/tree/master/src/main/java/data)
![Data Class Diagram](images/class/Data.png)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

more diagrams can be included, such as Generic Sequence Diagram.

Comment thread docs/DeveloperGuide.md
@@ -4,9 +4,457 @@

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job on including very detailed descriptions of each component of your code.

Comment thread docs/DeveloperGuide.md Outdated
}
}
}

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great job on providing a code snippet to allow us to understand this functionality.

yeozongyao pushed a commit to yeozongyao/tp that referenced this pull request Apr 4, 2024
…ind_function

Expanding find function and update user guide
Comment thread docs/DeveloperGuide.md

@clarencepohh clarencepohh Apr 5, 2024

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello, I think your DG review is on the wrong group. Perhaps you are supposed to review T14-2: OmniTravel instead?

kyhjonathan and others added 30 commits April 15, 2024 20:59
# Conflicts:
#	docs/DeveloperGuide.md
…to not show colon for time for the event and deadline update feature
…quence diagram to make it more readable, corrected image path
Amendments to DG and more test cases
Fixing changes from aakash' PR
# Conflicts:
#	docs/DeveloperGuide.md
#	src/main/java/data/TaskManager.java
Add PPP and resolve merge issues
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants