[T09-2] Anakin #65

thanh-ntt · 2018-09-20T02:00:46Z

@leeyjjoel @tomforge @yujiatay @Lessthanfree

nus-se-pr-bot · 2018-09-20T02:05:13Z

Hi @truongthanh2606, your pull request title is invalid.

For PR sent to satisfy a learning outcome, the PR name should be in the format of [Learning Outcome ID][Team ID] Your Name, where [Learning Outcome ID] has no dashes or spaces (e.g. [W3.1a]) and [Team ID] has one dash only and no spaces (e.g. [W14-2] means Wednesday 2pm (14 hrs), Team 2).
E.g. If you are in tutorial W09 (i.e. Wednesday 9am), team 1, and is submitting a PR for LO W2.2b, the PR title would be [W2.2b][W09-1] James Yong. Note that your tutorial IDs are different from those shown in CORS/IVLE.

For team PR, the PR name should be in the format of [Team ID] Product Name (e.g. [T09-2] Contact List Pro).

Please follow the above format strictly and edit your title for reprocessing.

Note: this comment is posted by a bot. If you believe this is done in error, please create an issue at nus-se-pr-bot and add a link to this PR.

novellius

Kindly read the comments for suggestions. Do NOT close this PR. Please update your Developer Guide's appendix sections as stated in the project milestone requirements. Please read the requirements carefully for every week so that you don't miss the milestone requirements. Otherwise, fine work. Remember to tag all other group members (using the @ notation) in the PR description so that they can receive notifications regarding this PR.

novellius · 2018-10-01T01:58:08Z

README.adoc

+
+= Anakin
+
+image:https://api.codacy.com/project/badge/Grade/51c8e6629cba4d068c77e39bf0094e4c[link="https://app.codacy.com/app/leeyjjoel/main?utm_source=github.com&utm_medium=referral&utm_content=CS2103-AY1819S1-T09-2/main&utm_campaign=Badge_Grade_Dashboard"]


Why are there 2 codacy badges in the ReadMe.md?

novellius · 2018-10-01T01:59:59Z

build.gradle

-        'site-name': 'AddressBook-Level4',
-        'site-githuburl': 'https://github.com/se-edu/addressbook-level4',
+        'site-name': 'Anakin',
+        'site-githuburl': 'https://github.com/CS2103-AY1819S1-T09-2/Main.git',


Is the site-githuburl still /Main.git instead of /main.git? Should it contain .git?

Rectified in 68fbd75

novellius · 2018-10-01T02:01:47Z

docs/DeveloperGuide.adoc

@@ -12,7 +12,7 @@ ifdef::env-github[]
 :note-caption: :information_source:
 :warning-caption: :warning:
 endif::[]
-:repoURL: https://github.com/se-edu/addressbook-level4/tree/master
+:repoURL: https://github.com/CS2103-AY1819S1-T09-2/Main.git


repoURL should not have .git at the back.

Rectified in ccaca8f

novellius · 2018-10-01T02:04:12Z

docs/UserGuide.adoc

-* *History* : `history`
-* *Undo* : `undo`
-* *Redo* : `redo`
+* See above please :)


Is there a reason to not have a command summary? Perhaps you can add it back once the user guide is filled with more commands.

novellius · 2018-10-01T02:05:56Z

docs/DeveloperGuide.adoc

@@ -12,7 +12,7 @@ ifdef::env-github[]
 :note-caption: :information_source:
 :warning-caption: :warning:
 endif::[]
-:repoURL: https://github.com/se-edu/addressbook-level4/tree/master
+:repoURL: https://github.com/CS2103-AY1819S1-T09-2/Main.git

 By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`



Where are the updated user stories, use cases, NFRs and product scope?

Please refer to them at https://github.com/CS2103-AY1819S1-T09-2/main/blob/master/docs/DeveloperGuide.adoc

novellius · 2018-10-01T02:09:41Z

docs/UserGuide.adoc

-* Existing values will be updated to the input values.
-* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
-* You can remove all the person's tags by typing `t/` without specifying any tags after it.
+*Name will be taken as a string.


You need to check whether you have applied the markup syntax correctly.

Rectified in 2e3bcec

novellius · 2018-10-01T02:10:47Z

docs/UserGuide.adoc

 ****

 Examples:
+* `newdeck n/My First Deck`


It would be good practice to ensure that your examples have a consistent format across the commands.

novellius · 2018-10-01T02:13:32Z

src/main/java/seedu/address/model/Anakin_deck/Anakin_Card.java

+/**
+ * Represents a Card inside a Deck.
+ */
+public class Anakin_Card {


Class names should not have underscores. Ensure that they follow PascalCase. Perhaps you can rename it to AnakinCard.

Resolved in #146

novellius · 2018-10-01T02:14:11Z

src/main/java/seedu/address/model/Anakin_deck/Anakin_Deck.java

+/**
+ * Represents a Deck inside Anakin.
+ */
+public class Anakin_Deck {


Same as above comment, the class name needs to be changed.

Resolved in #146

novellius

Overall, good job. Most of the documentation is updated. Some points to note:

ContactUs page needs to be changed (This is your product, they should not be contacting Prof. Damith)
For features yet to be implemented by the milestone, mark them as "Coming in V2.0" in the UserGuide
Certain badges does not seem to be following your team repo, but a member's repo's status instead. (E.g. AppVeyor, Codacy)
As usual, do not close the PR. Continue to work on your individual features and upgrade the documentation as needed.

novellius · 2018-10-07T05:35:14Z

docs/DeveloperGuide.adoc

-.List of per-file attributes, excluding Asciidoctor's built-in attributes
-|===
-|Attribute name |Description |Default value
+*Value proposition*: manage flashcards faster than a typical mouse/GUI driven app


Perhaps your value proposition can be more detailed so that users are more tempted to try the app? (What is the benefit of managing flashcards faster than manual/mouse/GUI driven app?)

novellius · 2018-10-07T05:35:48Z

docs/DeveloperGuide.adoc


-The files in link:{repoURL}/docs/templates[`docs/templates`] controls the rendering of `.adoc` files into HTML5.
-These template files are written in a mixture of https://www.ruby-lang.org[Ruby] and http://slim-lang.com[Slim].
+|`* * *` |user |find a person by name |locate details of persons without having to go through the entire list


Is Anakin keeping a list of persons in addition to flashcards?

novellius · 2018-10-07T05:46:32Z

docs/DeveloperGuide.adoc


-[discrete]
-==== `Logic` component
+*Alternate Use Case*


Does this mean there are alternative methods to delete a card from the deck? Perhaps you can place them under extensions [E.g. 3b. User selects a deck. (Rest of alternate path)]

novellius · 2018-10-07T05:49:00Z

docs/DeveloperGuide.adoc


 [appendix]
 == Non Functional Requirements

 .  Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `9` or higher installed.
-.  Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
+. Should be usable on a laptop with average hardware
+. Internal state should be persistent


Perhaps the term internal state can be clearer? Does it refer to storage? Or whenever the App is launched, it resumes the previous session state the user has left it? You can define the meaning under glossary.

novellius · 2018-10-07T05:53:40Z

docs/DeveloperGuide.adoc

-
-[[Docs-PerFileDocSettings]]
-=== Per-file Documentation Settings
+[appendix]


Is there a reason for removing the design, implementation, documentation, testing and devops? These are required in the end product. Remember that the developer guide is supposed to guide new developers in performing certain tasks like testing, setting up documentation etc.

novellius · 2018-10-07T06:13:34Z

docs/UserGuide.adoc

-Exits the program. +
-Format: `exit`
+****
+* Note: User must be inside a deck to perform this command.


The "Note:" here feels odd when the statement is placed in a box.

novellius · 2018-10-07T06:15:11Z

docs/UserGuide.adoc

-* *History* : `history`
-* *Undo* : `undo`
-* *Redo* : `redo`
+A convenient cheat sheet of commands


In your command summary, the description of certain commands seems different from that in the earlier section.

novellius · 2018-10-07T06:16:43Z

README.adoc

 ifdef::env-github[]
-image::docs/images/Ui.png[width="600"]
+image:docs/images/ui-mockups/Gameplay-Question.png[width="400"]


UI mockups should be 1 screenshot

novellius · 2018-10-07T06:17:11Z

README.adoc

-** A more sophisticated GUI that includes a list  panel and an in-built Browser.
-** More test cases, including automated GUI testing.
-** Support for _Build Automation_ using Gradle and for _Continuous Integration_ using Travis CI.
-
 == Site Map

 * <<UserGuide#, User Guide>>


You should remove the link to Learning Outcomes in your final product.

novellius · 2018-10-07T06:19:29Z

src/main/java/seedu/address/logic/Anakinparser/AnakinNewDeckCommandParser.java

+        }
+
+        /*
+        Name name = ParserUtil.parseName(argMultimap.getValue(PREFIX_NAME).get());


Dead code should be removed.

novellius

Some comments:

You are supposed to tag your latest commit (before the deadline) as v1.2.
You have to tag features listed in UserGuide as "Coming in v2.0" if it is not implemented yet.
Do continue to update your DeveloperGuide, and watch out for mistakes in your diagrams.
Try to standardize your component diagrams.
Try to fix CheckStyle errors so that Travis can actually run tests to see if your code is working as intended.
Please read the comments, and ask questions if there is anything unclear.
Keep up the good work.

novellius · 2018-10-20T00:52:11Z

docs/AboutUs.adoc

-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== David Goh
+image::lessthanfree.png[width="150", align="left"]


@Lessthanfree Your picture may need to be changed such that your face can be seen more clearly.

novellius · 2018-10-20T00:57:04Z

README.adoc

 ifdef::env-github[]
-image::docs/images/Ui.png[width="600"]
+image:docs/images/ui-mockups/Gameplay-Question.png[width="400"]
+image:docs/images/ui-mockups/Gameplay-Answer.png[width="400"]


You need to have your one of your images named "docs/images/Ui.png" so that our scripts can download it.

novellius · 2018-10-20T01:01:14Z

docs/UserGuide.adoc

+|=======================================================================
+|Command | What does it do?
+|`list` | Lists all decks
+|`newdeck [n/NAME]` | Creates a new deck. /n is optional


Should it be "n/" instead of "/n"?

novellius · 2018-10-20T01:04:01Z

docs/DeveloperGuide.adoc


-*API* :
-link:{repoURL}/src/main/java/seedu/address/logic/Logic.java[`Logic.java`]
+The `LogicManager` contains an `AnakinModel`, an `AnakinParser`, and a `CommandHistory`.


I cant seem to find AnakinModel in your diagram. Your diagram has an orange dotted line pointing from LogicManager to CommandHistory. Does that mean that it contains and modifies CommandHistory? [It was not stated in the Legend]

novellius · 2018-10-20T01:06:37Z

docs/DeveloperGuide.adoc


-*API* : link:{repoURL}/src/main/java/seedu/address/model/Model.java[`Model.java`]
+Structure of the Model Component


Try to standardize your class diagram appearance.

novellius · 2018-10-20T01:09:16Z

docs/DeveloperGuide.adoc


-*API* : link:{repoURL}/src/main/java/seedu/address/model/Model.java[`Model.java`]
+Structure of the Model Component

 The `Model`,


I believe your model is actually called AnakinModel instead of Model? [The diagram does not reflect the new name]

novellius · 2018-10-20T01:11:26Z

docs/DeveloperGuide.adoc


-// end::dataencryption[]
+These operations are exposed in the Model interface as: Model#addCard(Card card), Model#deleteCard(Card card), Model#updateCard(Card target, Card editedCard) respectively.


Remember to rename Model to the actual name of the interface.

novellius · 2018-10-20T01:15:00Z

docs/DeveloperGuide.adoc


-Certain properties of the application can be controlled (e.g App name, logging level) through the configuration file (default: `config.json`).
+image::NewCard sequence diagram.png[width="790", align="left"]


Make sure the arrows touch the activation bars.

Would alt be more suitable than opt? If exceptions are thrown, would the rest of the operation still occur in Anakin and UniqueCardList? Using opt would imply that an Exception instance is created, but add operation still continues.

It is fine to leave out cases where exception is thrown. You just need to explain the main scenario of newcard operation.

novellius · 2018-10-20T01:17:48Z

docs/DeveloperGuide.adoc


-[TIP]
-Attributes left unset in the `build.gradle` file will use their *default value*, if any.
+image::NewDeck.png[width="790", align="left"]


The comments for the above Sequence diagram applies here.

novellius · 2018-10-20T01:21:05Z

docs/DeveloperGuide.adoc


-=== Site Template
+Step 5. Card A is shown to the user more regularly when he reviews the same deck in the future.


Do try to add more information on the implementation (Diagrams and its explanations can help) (Design considerations can help too)

Add command, Date and UUID

And Formatting

Import Export feature

Add Javadoc comment

Fix bugs related to import deck command

Also update exception messages for EditDeck and NewDeck

* Add FindCommandSystemTest Deck level checks * Fix Style Errors * Fix Style Errors * Add Deck_G and Deck_H * Fix Style Errors * Change person to deck * Change AddressbookMessages to Messages Co-Authored-By: leeyjjoel <lee.yi.jie.joel@gmail.com>

Refactor Logic

Also update exception messages for EditDeck and NewDeck

Co-Authored-By: Lessthanfree <35485082+Lessthanfree@users.noreply.github.com>

Fix bug: developer guide does not show image content

Fix UserGuide and Add appendix to Dev Guide

Update PPP

Update ppp

New card sequence diagram is now shown in developer guide

Fix image not shown bug

Update Developer Guide and PPP

Update Developer guide

* Fix style errors * Fix style errors

nus-se-pr-bot added the FormatCheckRequested label Sep 20, 2018

thanh-ntt changed the title ~~WIP: CS2103-AY1819S1-T09-2~~ [T09-2] Anakin Sep 30, 2018

nus-se-pr-bot added team.2 tutorial.T09 and removed FormatCheckRequested labels Sep 30, 2018

nus-se-pr-bot assigned novellius Sep 30, 2018

nus-se-pr-bot requested a review from novellius September 30, 2018 06:43

novellius reviewed Oct 1, 2018

View reviewed changes

novellius added the Mid-v1.1-Reviewed label Oct 1, 2018

novellius reviewed Oct 7, 2018

View reviewed changes

novellius added the v1.1-Reviewed label Oct 7, 2018

novellius reviewed Oct 20, 2018

View reviewed changes

novellius added the v1.2-Reviewed label Oct 20, 2018

bannified pushed a commit to bannified/addressbook-level4 that referenced this pull request Oct 24, 2018

Merge pull request nus-cs2103-AY1819S1#65 from dioptrique/AddCommand

75f298f

Add command, Date and UUID

kr0stofa and others added 10 commits October 29, 2018 14:18

Update Tests

3c72e1a

And Formatting

Merge pull request #166 from Lessthanfree/ImportExportFeature

3a24530

Import Export feature

Fix bugs related to import deck command

730a154

Fix style

6946cdd

Add Javadoc comment

Merge pull request #168 from truongthanh2606/master

8570a75

Fix bugs related to import deck command

Update exception handling for ImportDeckCommand

39396b8

Also update exception messages for EditDeck and NewDeck

Move some command messages to Messages.java

a70b678

Formatting

bd74a70

More Formatting

c682539

pangjiahao added a commit to pangjiahao/cs2103-u-schedule that referenced this pull request Oct 30, 2018

Merge pull request nus-cs2103-AY1819S1#65 from bryanwongweiheng/master

d656e21

Refactor Logic

kr0stofa added 4 commits October 30, 2018 12:58

Update exception handling for ImportDeckCommand

a9876ab

Also update exception messages for EditDeck and NewDeck

Move some command messages to Messages.java

85f94a2

Formatting

099885d

More Formatting

1e9b17a

kr0stofa and others added 30 commits November 12, 2018 19:50

Fix formatting of import documentation

c19de40

Update User Guide

24d2f7d

Add Manual Testing Appendix to DevGuide

2e43bcd

Merge remote-tracking branch 'Lessthanfree/finalDocs' into finalDocs

66e547e

Fix typo in Userguide

e18e85e

Update Devguide

4b5313a

Co-Authored-By: Lessthanfree <35485082+Lessthanfree@users.noreply.github.com>

Fix Typo in Devguide

6c3d8b9

Co-Authored-By: Lessthanfree <35485082+Lessthanfree@users.noreply.github.com>

Update Devguide

1426cb6

Co-Authored-By: Lessthanfree <35485082+Lessthanfree@users.noreply.github.com>

Tweak Devguide appendix

8411055

Update ppp

6a6d95b

Fix bug: developer guide does not show image content

Merge pull request #272 from Lessthanfree/finalDocs

ea4ca17

Fix UserGuide and Add appendix to Dev Guide

Merge branch 'master' into master

53b72ce

Merge remote-tracking branch 'origin/master'

e03533a

[WIP]: Update PPP (#268)

293e6e2

Update PPP

Merge branch 'master' of https://github.com/leeyjjoel/Main

aa9bfa5

Resolve merge conflicts

3fcaa26

Merge branch 'master' into master

f0117b8

Merge pull request #273 from truongthanh2606/master

97e7e25

Update ppp

Merge remote-tracking branch 'origin/master'

ed590c6

Fix image not shown bug

53f4760

New card sequence diagram is now shown in developer guide

Fix Grammar add developer guide section

603c7c1

Merge branch 'master' into updateDevGuide

c41e05a

Merge pull request #274 from truongthanh2606/master

dc71e94

Fix image not shown bug

Merge branch 'master' into updateDevGuide

f4958a0

Fix style errors

d77bea1

Fix style errors

5ec1697

Merge pull request #275 from leeyjjoel/updateDevGuide

b7f0251

Update Developer Guide and PPP

Update Developer guide

66607fb

Merge pull request #277 from truongthanh2606/master

c1745e2

Update Developer guide

Fix grammatical errors in PPP (#278)

a1ff6b0

* Fix style errors * Fix style errors


		= Anakin

		image:https://api.codacy.com/project/badge/Grade/51c8e6629cba4d068c77e39bf0094e4c[link="https://app.codacy.com/app/leeyjjoel/main?utm_source=github.com&utm_medium=referral&utm_content=CS2103-AY1819S1-T09-2/main&utm_campaign=Badge_Grade_Dashboard"]


		API : link:{repoURL}/src/main/java/seedu/address/model/Model.java[`Model.java`]
		Structure of the Model Component


		// end::dataencryption[]
		These operations are exposed in the Model interface as: Model#addCard(Card card), Model#deleteCard(Card card), Model#updateCard(Card target, Card editedCard) respectively.


		Certain properties of the application can be controlled (e.g App name, logging level) through the configuration file (default: `config.json`).
		image::NewCard sequence diagram.png[width="790", align="left"]


		=== Site Template
		Step 5. Card A is shown to the user more regularly when he reviews the same deck in the future.

[T09-2] Anakin #65

Are you sure you want to change the base?

[T09-2] Anakin #65

Conversation

thanh-ntt commented Sep 20, 2018 • edited Loading

nus-se-pr-bot commented Sep 20, 2018

novellius left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kr0stofa Nov 11, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

novellius left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

novellius left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thanh-ntt commented Sep 20, 2018 •

edited

Loading

kr0stofa Nov 11, 2018 •

edited

Loading