[CS2103T-F12-4] Billboard #20
Conversation
Adjust profile images naming, Remove learning outcomes
|
|
||
| *MSS* | ||
|
|
||
| 1. User requests to list expenses |
There was a problem hiding this comment.
Do you think that the listing step is redundant? What if the user already knows the index of the expense he wants to tag?
|
|
||
|
|
||
| [Discrete] | ||
| === UC02: Filter expenses by tag |
There was a problem hiding this comment.
Maybe you could filter by other fields also?
docs/DeveloperGuide.adoc
Outdated
|
|
||
|
|
||
| [Discrete] | ||
| === UC06: Finding a record with a specified keyword |
There was a problem hiding this comment.
Maybe could use precondition of the keyword being valid characters (eg. English)
| _{More to be added}_ | ||
|
|
||
| [appendix] | ||
| == 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 expenses/income records without a noticeable sluggishness in performance for typical usage. | ||
| . A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse. |
There was a problem hiding this comment.
Maybe can refine this NFR by indicating how typing is faster than using mouse? Quantitatively?
|
|
||
| |`* * *` |user |Tag a record | Categorize and better manage my records | ||
|
|
||
| |`* * *` |user |Specify a time stamp on expenses|Know when I spend my money |
There was a problem hiding this comment.
Are you considering having a feature of notifying the user?
docs/DeveloperGuide.adoc
Outdated
|
|
||
| |`* * *` |user |find a person by name |locate details of persons without having to go through the entire list | ||
| |`* * *` |Visually inclined user |Attach an image to each record |Conveniently record additional details of the expense instead of typing it all out |
There was a problem hiding this comment.
Is this really a must-have? Can the software still maintain its function without this feature?
|
|
||
| |`* * *` |user |Specify a time stamp on expenses|Know when I spend my money | ||
|
|
||
| |`* * *` |user | Sort and filter records by category or tag | Know how my spending/income is distributed |
There was a problem hiding this comment.
Maybe can consider adding a search function?
|
|
||
| |`* * *` |user | Archive past records | Better manage current expenses | ||
|
|
||
| |`* * *` | user | Unarchive records | |
There was a problem hiding this comment.
Would you consider having unarchive records as a must have, or should it be classified as nice to have?
More use cases and NFRs added to DG.
|
|
||
| The following sequence diagram shows how the undo operation works: | ||
|
|
||
| .Interactions Inside the Logic Component for the `undo` Command | ||
| image::UndoSequenceDiagram.png[] |
There was a problem hiding this comment.
Oops, thank you for pointing out that.
docs/DeveloperGuide.adoc
Outdated
|
|
||
| These actions are facilitated by the `ArchiveWrapper` and `Archive` classes: | ||
|
|
||
| * `Archive` extends from `ExpenseList` in order to encapsulate an archive name and a list of expenses together as an archive. |
docs/DeveloperGuide.adoc
Outdated
| Firstly, the user has the application running and has a non empty list of current expenses. The user can enter the `list` command to bring up | ||
| this list. + | ||
|
|
||
| Next, the user executes the command `archive add 3 arc/archiveName` to archive an expense. + |
There was a problem hiding this comment.
Might want to break this up into steps
|
|
||
| // end::finding[] | ||
|
|
||
| === Statistics |
|
|
||
| Billboard will store all the command entered even the command is never executed. | ||
|
|
||
| This function is facilitated by the `CommandHistory` class. |
There was a problem hiding this comment.
No information about CommandHistory. Could add a class diagram
| The CommandHistory will be initialized with no command state, | ||
| and the statePointer is not pointing to any command state. | ||
|
|
||
| .Initial state of CommandHistory |
There was a problem hiding this comment.
Seems like the diagram does not really serve a purpose
docs/DeveloperGuide.adoc
Outdated
| .Interactions Inside the Logic Component for the `delete` Command | ||
| image::DeleteSequenceDiagram.png[] | ||
|
|
||
| The LogicManager will store the command to CommandHistory before parsing it to ensure all commands are saved. |
docs/DeveloperGuide.adoc
Outdated
| The archive feature supports the following actions: | ||
|
|
||
| * Creating an archive | ||
| * Added an expense to an archive |
There was a problem hiding this comment.
There's past tense here, but the rest of this list is present continuous.
docs/DeveloperGuide.adoc
Outdated
| this list. + | ||
|
|
||
| Next, the user executes the command `archive add 3 arc/archiveName` to archive an expense. + | ||
| The command is first parsed by `BillboardParser` to determine what kind of general command it is. `archive` indicates it is an archive command so the remaining input is parsed through `ArchiveCommandParser`. + |
There was a problem hiding this comment.
This paragraph uses the same font and bolding for classes, arguments, commands, and quotations. This might be confusing to the reader as they might not know what each bolded word represents. Maybe separating out the font and standardizing would make it better.
| `Storage` to serialize into JSON format and writes it into the JSON file. | ||
|
|
||
| ==== Design Considerations | ||
| ===== Aspect: Data Structure to hold archives in `ArchiveWrapper` |
There was a problem hiding this comment.
Neat and tidy, perhaps a table could also be considered.
| @@ -98,7 +100,7 @@ image::LogicClassDiagram.png[] | |||
| *API* : | |||
| link:{repoURL}/src/main/java/seedu/address/logic/Logic.java[`Logic.java`] | |||
There was a problem hiding this comment.
What's the difference between this diagram and the diagram under the architecture part? Seems like it's repeated..
|
|
||
| The following sequence diagram shows how the undo operation works: | ||
|
|
||
| .Interactions Inside the Logic Component for the `undo` Command | ||
| image::UndoSequenceDiagram.png[] |
| image::UndoRedoState4.png[] | ||
|
|
||
| Step 6. The user executes `clear`, which calls `Model#commitAddressBook()`. Since the `currentStatePointer` is not pointing at the end of the `addressBookStateList`, all address book states after the `currentStatePointer` will be purged. We designed it this way because it no longer makes sense to redo the `add n/David ...` command. This is the behavior that most modern desktop applications follow. | ||
| Step 6. The user executes `clear`, which calls `VersionedBillboard#commit()`. Since the `currentStatePointer` is not pointing at the end of the `stateList`, all billboard states after the `statePointer` will be purged. We designed it this way because it no longer makes sense to redo the `add n/buy ...` command. This is the behavior that most modern desktop applications follow. |
There was a problem hiding this comment.
If clear deletes all the states, then where does current state point to?
There was a problem hiding this comment.
The current state should point to bb3:Billboard, sorry for my typo. Just in case you are unclear about how it works, I will further explain it. If you already know how it works, please ignore below. If the user executes any other billboard editing command(add, delete etc), then all the state after the current state will be removed, then execute the command, and store it into the state list, current state pointer will point to that state. And you will not able to redo cause the state pointer is pointing to the last state in the list.
docs/DeveloperGuide.adoc
Outdated
| `ArchiveWrapper` is used in `ModelManager` and its respective operations are called to access and manipulate archive expenses when an archive command is entered. + | ||
| Such operations include: | ||
|
|
||
| * `ArchiveWrapper#AddArchive(Archive)` - Adds the given archive to the current map of archive objects. |
There was a problem hiding this comment.
This information can be found in Java doc. We feel that it's a bit redundant to leave them here.
|
|
||
| These interactions with `Model` by `AddArchiveCommand` can be shown in the cropped portion of the full sequence diagram below: | ||
|
|
||
| image::AddArchiveCommandSequenceDiagram_executeCommand.png[] |
|
|
||
| Below is the full sequence diagram of the operation: | ||
|
|
||
| image::AddArchiveCommandSequenceDiagram.png[] |
|
|
||
| The following sequence diagram shows how the adding tag operation works. | ||
|
|
||
| image::AddTagSequenceDiagram.png[] |
There was a problem hiding this comment.
retrieveTag's return object is not defined in this sequence diagram.
There was a problem hiding this comment.
also the lines should stop after the cross, though we are aware of the technical difficulty of doing so.
…cs-asynchronously Generate statistics asynchronously
WeiWen's PPP and Delete dead code
* master: Fixed some sentences Completed developer guide Updated overall flow for developer guide and added new chart Edited introduction for developer guide
…wayne Updated UGDG and PPP
…CS2103T-F12-4/main into update-ug-dg-ppp-wayne * 'update-ug-dg-ppp-wayne' of https://github.com/AY1920S1-CS2103T-F12-4/main:
Recurring expenses
* master: Fix increment tag count Fix bugs mentioned in Wai Fong's review Fix codacy Fix bugs and javadoc typos Fix checkstyletest Fix codacy Fic checkstyletest Fix test Add recurring expenses test cases Remove duplicate getClone method Implement list and add recurrence without undo/redo and save/load Init commit for recurring expenses
…wayne Update ug dg ppp wayne
PPP for weijie
Weijie PPP Final edits
# Conflicts: # docs/DeveloperGuide.adoc
Xinming PPP UGDG
@Davidcwh
@waifonglee
@waynefong0401
@xinmingzh