-
Notifications
You must be signed in to change notification settings - Fork 55
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
[T16-2] ProManage #46
base: master
Are you sure you want to change the base?
[T16-2] ProManage #46
Conversation
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.
Dear team T16-2,
Based on your developer guide, your implementation progress is fine for 3.1 and 3.2. Do note that in the final deliverables each team member should submit at least one feature and included 1 UML diagram in the documentation.
Some instructions for your future deliverables:
- Regarding diagrams, avoid drawing big diagrams with too much details. Diagrams with low-level details are discouraged, as it is against the top-down approach to documentation.
- You may also use code snippets, but it should be minimal as the code gets outdated very quickly.
|
||
Given below is an example usage scenario and how the undo/redo mechanism behaves at each step. | ||
image::SortSequenceDiagram.png[width="650"] |
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.
Good job here, on the sequence diagram:
- drew proper lifelines for each object
- specified invocation method
- use dashed arrows for return calls.
- clear separation of Logic classes and Model classes
docs/DeveloperGuide.adoc
Outdated
The following activity diagram summarizes what happens when a user executes a new command: | ||
// tag:: Sorting[] | ||
|
||
=== Event Sorting |
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.
Are section 3.1 and 3.3 referring to the same thing? As both are using the same header Event Sorting.
docs/DeveloperGuide.adoc
Outdated
|
||
The sequence diagram below illustrates the execution of the `invite` command. | ||
|
||
image::InviteSequenceDiagram.png[width="800"] |
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.
Good job here on the sequence diagram.
- drew proper lifelines for each object
- specified invocation method
- use dashed arrows for return calls.
- clear separation of Logic classes and Model classes
However, note that:
To reduce clutter, activation bars and return arrows may be omitted if they do not result in ambiguities or loss of information. Informal operation descriptions such as those given in the example below can be used, if more precise details are not required for the task at hand.
Add Event Clash Verification feature for Invite Command and Debug Person and Events PE bug.
Updated PPP, user guide, developer guide, list tests and add and edit parser.
# Conflicts: # docs/DeveloperGuide.adoc
…into FinalUpdates * 'master' of git://github.com/CS2113-AY1819S1-T16-2/main: Added Undo/Redo implementation to Developer Guide (#158) Checkstyle Updated the PPP and user guide and developer guide, add and edit command and list tests.
Updated developer guide appendix F
Increase width
Added PPP, updates to DeveloperGuide and UserGuide
Update UG, DG, PPP for Jie Liang
Chopped down the overly long PPP
Update Jeevan's PPP to fit 10 page limit
* updated ppp * updated user guide
* updated ppp * updated user guide * added showmine in summary
@IcedCoffeeBoy @Jeevz10 @perrythewang @fr3ddy4