[CS2113-W13-2] CLI-nton #85
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cirelesna
reviewed
Apr 3, 2024
docs/DeveloperGuide.md
Outdated
|
|
||
| ## Data Component | ||
| ### API: [Data](https://github.com/AY2324S2-CS2113-W13-2/tp/tree/master/src/main/java/data) | ||
|  |
There was a problem hiding this comment.
Could the visual be split up into smaller parts?
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 | |
There was a problem hiding this comment.
Could there be more user stories for v1.0 and v2.0?
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. | ||
|
|
There was a problem hiding this comment.
Could a sequence diagram illustrate how it works better?
| ## Storage component | ||
| **API** : [Storage.java](https://github.com/AY2324S2-CS2113-W13-2/tp/blob/master/src/main/java/storage/Storage.java) | ||
|
|
||
| The 'storage' component: |
nikhil-2101
reviewed
Apr 3, 2024
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. |
There was a problem hiding this comment.
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.
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) | ||
|  |
There was a problem hiding this comment.
more diagrams can be included, such as Generic Sequence Diagram.
| @@ -4,9 +4,457 @@ | |||
|
|
|||
There was a problem hiding this comment.
Great job on including very detailed descriptions of each component of your code.
docs/DeveloperGuide.md
Outdated
| } | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
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
clarencepohh
reviewed
Apr 5, 2024
There was a problem hiding this comment.
Hello, I think your DG review is on the wrong group. Perhaps you are supposed to review T14-2: OmniTravel instead?
# Conflicts: # docs/diagrams/class/Data.puml
Improve UG formatting and fix documentation errors from PE-D
DG and README improvements
# 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
Amend PPP
Fixing changes from aakash' PR
# Conflicts: # docs/DeveloperGuide.md # src/main/java/data/TaskManager.java
Add PPP and resolve merge issues
Change PPP
Resolve merge conflicts
# Conflicts: # docs/DeveloperGuide.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.