[CS2113-T14-2] eCardnomics by kaijiel24 · Pull Request #39 · nus-cs2113-AY2021S1/tp

kaijiel24 · 2020-10-01T06:15:10Z

Flash Card manager for Economics students on Command Line

…into master

…into trang-UG-DG

update UG and DG

…into branch-UserGuide Merge branch-UserGuide into master

Aliciaho · 2020-10-28T04:38:07Z

+
+#### Commands
+
+![DG-Design Commands UML](./images-dg/DG-Design-Commands.png?raw=true "Commands UML Class Diagram")


Maybe you would like to break this diagram into two parts, so that it is less complicated?

Changed, thanks!

Aliciaho · 2020-10-28T04:40:11Z

+   interacts with `GameStorage` on package-private basis; i.e., `GameEngine` and `GameStorage` have full mutual
+    access as if they were a single class. This is one of the main intentional design decisions.
+
+![DG-Implementation-Features-Game-Mode-Architecture](./images-dg/Game-Mode-Design.png?raw=true "Game Mode


Maybe you would like to split up this digram into two parts, so that it is less complicated?

Changed, thanks!

Aliciaho · 2020-10-28T04:41:06Z

+
+The following elaborates the execution flow of Game Mode, from after a `start` command has been parsed in Normal Mode:
+
+![DG-Implementation-Features-Game-Mode-Sequence](./images-dg/Game-Mode-Sequence.png?raw=true "Game Mode UML Sequence


Maybe it would be better to simplify this diagram/ split them up into smaller parts, so that it would be easier to follow?

Changed with reference frames, thanks!

Implement one-liner commands

Merge branch-UserGuide to master

Add DG for Storage class

Update Help commands

samuellleow · 2020-10-29T01:30:39Z

+An additional feature targeted at students who wish to use add more style to their flash cards outside of the command 
+line option to allow keep things interesting when they are revising.
+
+The `PowerPointCommand` is parsed by `NormalParser` but the "Print to PowerPoint" command can be called from both Normal 


Should there be a return to PowerpointCommand after Powerpoint is created in the sequence diagram?

I believe that the box to contain the "opt" is wrong, you may refer to the notes again, it should be a sharp box with a chip of the corner.

samuellleow · 2020-10-29T01:52:43Z

+
+#### How to **components** interact with one another
+![Sequence Diagram](images-dg/Sequence%20Diagram.png)
+The **Sequence Diagram** above shows how the components interact for a basic `create <deck name>` command where a new deck is created and added in to the `Deck List`.


I believe the return arrow should be a dotted line

The arrows coming into the UI class shouldnt be into or from the middle of the box, should be from the top or bottom of the box

samuellleow · 2020-10-29T01:59:21Z

+The user can also modify to tags of the decks by using tag or untag command, and uses search by tag to find
+a group of decks he/she is interested in.
+
+![DG-Implementation-Features-TagSequence](./images-dg/Tag.png?raw=true)


Should there be a return arrow? Prof said that it is optional if a void function is called

siewwencode

Overall the DG diagrams looks engaging in a sense that the diagrams are colored. The text explanation is clear and easy to understand.
However, you can consider having different markdowns for class and methods.

siewwencode · 2020-10-29T02:08:10Z

+    * `Deck List` : A complete list of all the `Deck`s in memory.
+* `Storage` Reads and writes data from and to a text file.
+
+#### How to **components** interact with one another


This part is a bit confusing? Perhaps you can elaborate more?

siewwencode · 2020-10-29T02:08:33Z

+* `Storage` Reads and writes data from and to a text file.
+
+#### How to **components** interact with one another
+![Sequence Diagram](images-dg/Sequence%20Diagram.png)


You can consider resizing your diagram such that the text size in the diagram matches the the text size of the main text of the diagram.

siewwencode · 2020-10-29T02:08:55Z

+* `Storage` Reads and writes data from and to a text file.
+
+#### How to **components** interact with one another
+![Sequence Diagram](images-dg/Sequence%20Diagram.png)


Should this be a dotted arrow?

siewwencode · 2020-10-29T02:09:41Z

+1. The overall logic component consists of the Parser class and Command class.
+2. The Parser parses the user input and creates the respective Command object.
+3. This command will be executed by the Main class.


You might have missed out bolding the classes here

siewwencode · 2020-10-29T02:10:06Z

+  sequence diagram showcasing this interaction, for execution of a `CreateCommand`, e.g. `create
+   microeconomics`:
+
+![DG-Design CreateCommand Sequence UML](./images-dg/DG-Design-Sequence-Diagram.png?raw=true "CreateCommand UML


You can consider terminating CreateCommand

@zhixiangteoh

Won't terminate CreateCommand here because this just shows the creation of CreateCommand, returning createCommand object whose sole purpose of life is to have its execute() method called, but in this sequence diagram that is essentially a snippet of the lifeline of createCommand I cannot also include its interactions with Main class because that's out of scope here; the point is that createCommand does exist for the whole duration shown here.

Although, I should include some textual description of the gist of what I am conveying here, thanks!

siewwencode · 2020-10-29T02:10:26Z

+and Deck Mode. 
+
+The following diagram shows how the `PowerPointCommand`'s `execute()` calls the `createNewPowerPoint()` method of `PowerPoint`.
+![PPTX Sequence Diagram](images-dg/DG-PPTX-Sequence-Diagram.png)


Are you missing the return arrows?

siewwencode · 2020-10-29T02:10:47Z

+`toString(boolean isQuestion, int offset)` method of a `FlashCard`
+object.
+
+![DG-Implementation-Features-PP-Sequence](./images-dg/PP-Sequence.png?raw=true)


Are you labelling correct? Perhaps it should be toString(isQuestion, offset) and formatResponse(isQuestion, offset)

siewwencode · 2020-10-29T02:11:07Z

+The user can also modify to tags of the decks by using tag or untag command, and uses search by tag to find
+a group of decks he/she is interested in.
+
+![DG-Implementation-Features-TagSequence](./images-dg/Tag.png?raw=true)


Are you missing a return arrow here?

A minor comment: For the sequence diagram below, would it be better if Main class is put on the left-most side? Because I misunderstood it first.

I believe the idea we were trying to convey is that the user does not interact directly with the Main class, but directly with the Ui class instead via the Ui's readUserInput() method.

siewwencode · 2020-10-29T02:11:28Z

+
+The following elaborates the execution flow of Game Mode, from after a `start` command has been parsed in Normal Mode:
+
+![DG-Implementation-Features-Game-Mode-Sequence](./images-dg/Game-Mode-Sequence.png?raw=true "Game Mode UML Sequence


some return arrows are missing

Thanks for the input! Return arrows are not mandatory, so this was intentional.

samuellleow

Overall great design and explanation of the DG, do consider and review the mistakes I pointed.

samuellleow · 2020-10-29T02:35:22Z

+The user can also modify to tags of the decks by using tag or untag command, and uses search by tag to find
+a group of decks he/she is interested in.
+
+![DG-Implementation-Features-TagSequence](./images-dg/Tag.png?raw=true)


I believe that you can terminate the Ui class after printing the required statement

@alwaysnacy

update PPP link

…into master # Conflicts: # docs/DeveloperGuide.md # docs/images-dg/Tag-feature.png

update toc dg ug

Update DG and UG

Fix pptx deck mode bug

Update DG Storage sequence diagram to have transparent background

Update DG diagram

fix white bg images

fixes #237, fixes #244

gua-guargia mentioned this pull request Oct 11, 2020

Finalise file structure #93

Closed

alwaysnacy and others added 13 commits October 28, 2020 09:04

Merge branch 'master' of https://github.com/AY2021S1-CS2113-T14-2/tp …

552d8b3

…into master

add Tag-DG

f864b45

Merge branch 'master' of https://github.com/AY2021S1-CS2113-T14-2/tp …

ca17f2b

…into trang-UG-DG

Remove unused method and refactor delete branch for SLAP

e7995f0

Update .gitignore to not track data/deckList.txt

b1589d5

add TagFlow

7cb8027

Merge branch 'master' of https://github.com/AY2021S1-CS2113-T14-2/tp …

632852d

…into trang-UG-DG

Add one-shot delete deck command

217e7a7

update UG and DG

8be6150

Merge pull request #115 from alwaysnacy/master

4293095

update UG and DG

Add one-shot add flashcard command

38221c9

Move confirmation methods to Ui

39c2e00

Merge branch 'master' of https://github.com/AY2021S1-CS2113-T14-2/tp …

050cc1e

…into branch-UserGuide Merge branch-UserGuide into master

Aliciaho reviewed Oct 28, 2020

View reviewed changes

LiewWS and others added 12 commits October 28, 2020 13:17

add one-shot delete delete command

433adef

refactor update for SLAP

d79f978

Merge branch 'master' of https://github.com/AY2021S1-CS2113-T14-2/tp

db8a093

Merge pull request #116 from LiewWS/master

4d24af2

Implement one-liner commands

Merge branch 'master' of https://github.com/AY2021S1-CS2113-T14-2/tp

e5e4078

update UG to include one-line commands

105585d

Merge pull request #117 from LiewWS/branch-UserGuide

3481c10

Merge branch-UserGuide to master

update help command list for all modes

15b5125

fix checkstyle

53d1b84

Add DG for Storage class

433a10b

Merge pull request #121 from wangwaynesg/branch-StorageDG

155e07f

Add DG for Storage class

Merge pull request #119 from zhixiangteoh/master

219aa46

Update Help commands

samuellleow reviewed Oct 29, 2020

View reviewed changes

siewwencode reviewed Oct 29, 2020

View reviewed changes

samuellleow reviewed Oct 29, 2020

View reviewed changes

alwaysnacy and others added 30 commits November 9, 2020 22:11

update UG, DG and PPP

d6ab7dc

Merge pull request #233 from zhixiangteoh/master

db8e7bc

update PPP link

Merge branch 'alwaysnacy-Trang-addTests' into master

a3b03f5

no message

b388f89

update toc dg ug

a28ab1c

Merge branch 'master' of https://github.com/AY2021S1-CS2113-T14-2/tp …

dcca2af

…into master # Conflicts: # docs/DeveloperGuide.md # docs/images-dg/Tag-feature.png

Merge pull request #235 from zhixiangteoh/master

c57d351

update toc dg ug

no message

278c563

Merge pull request #236 from alwaysnacy/master

8e29b7d

Update DG and UG

Fixed bugs for pptx in deck mode and updated UG and DG

ee764af

Fixed bugs for pptx in deck mode and updated UG and DG

6974215

Update DG Storage sequence diagram to have transparent background

14334c2

Merge pull request #239 from kaijiel24/master

84a79d5

Fix pptx deck mode bug

Merge pull request #240 from wangwaynesg/master

ca79bb9

Update DG Storage sequence diagram to have transparent background

Update DG diagram

ed8a42a

Merge pull request #241 from kaijiel24/master

41bccf5

Update DG diagram

fix white bg images

01b27ef

Merge pull request #242 from LiewWS/master

23b3f01

fix white bg images

fixes #237

0e60f53

Merge branch 'master' of https://github.com/AY2021S1-CS2113-T14-2/tp

23185be

update UG setup instructions

c42be13

Merge pull request #243 from zhixiangteoh/master

2641cd3

fixes #237, fixes #244

Add files via upload

d2f258b

Add files via upload

bafa094

Delete alwaysnacy.png

4e65518

Add files via upload

3e4ae0f

Delete alwaysnacy.png

b6f37a3

Add files via upload

c8ad9df

Delete alwaysnacy.png

2fe00cc

Add files via upload

e76fc64


		#### Commands

		![DG-Design Commands UML](./images-dg/DG-Design-Commands.png?raw=true "Commands UML Class Diagram")


		The following elaborates the execution flow of Game Mode, from after a `start` command has been parsed in Normal Mode:

		![DG-Implementation-Features-Game-Mode-Sequence](./images-dg/Game-Mode-Sequence.png?raw=true "Game Mode UML Sequence

Uh oh!

Conversation

kaijiel24 commented Oct 1, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

siewwencode left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samuellleow left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

14 participants

kaijiel24 commented Oct 1, 2020 •

edited

Loading