Skip to content
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

[CS2103-W15-4] Pet Store Helper #4

Open
wants to merge 834 commits into
base: master
Choose a base branch
from

Conversation

umaikaze
Copy link

No description provided.

@umaikaze
Copy link
Author

umaikaze commented Feb 13, 2020

Usernames of team members: @shenghaoc @tianqi77 @Zhu-Ruicong @limdylan

@umaikaze umaikaze changed the title W15 Group 4 PR [CS2103-W15-4] Pet Store Helper Feb 13, 2020
@raivatshah
Copy link

raivatshah commented Mar 25, 2020

I like how Model was edited from the default version with specific changes. It is more clear with the Model to understand the codebase.

You may find it helpful to draw class diagrams before you implement all classes as it will allow all members of the team to come to a clear consensus about the functionality and structure of each class.

@harrychengly
Copy link

I think it would be good to include some diagrams in the implementations section when explaining a feature. It would be helpful for the developer to visualise the flow of the feature when reading.

@terencemah
Copy link

Some of the classes mentioned in the Developer Guide are not introduced before, so it is not clear what they refer to. Subsequently, it would be good to introduce all relevant classes systematically, so that there is coherent flow.


image::UndoRedoState3.png[]
image::displayDiagram2.png[]

Choose a reason for hiding this comment

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

displayDiagram2 not showing.


image::UndoRedoState1.png[]
image::displayDiagram1.png[]

Choose a reason for hiding this comment

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

displayDiagram1 not showing.

==== Proposed Implementation
// tag::display[]
=== Display
==== Implementation

Choose a reason for hiding this comment

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

Can include an activity diagram to facilitate understanding.

@PotatoCombat
Copy link

  1. (3.1.4) You should use a class diagram to explain it
  2. Step 2 should be broken down. It is too wordy and complicated.
  3. The ! thing should be after step 3
  4. In general, break down your steps into smaller simpler steps.
  5. Section 3.6 - you don’t explain how it’s done.

tianqi77 and others added 30 commits April 13, 2020 21:40
…into ug-update

# Conflicts:
#	docs/UserGuide.adoc
Update documents for shenghaoc
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.

10 participants