[CS2113-F15-1] Player2113 #55

songyuew · 2024-03-08T07:24:15Z

Player2113 is a CLI based software to help CS2113 student revise concepts encountered in the course.

Added more loggers

Update User Guide

Elyovs · 2024-04-03T05:28:23Z

docs/team/img/Results.puml

+Ui -> Parser : handleAnswerInputs(answer: String)
+activate Parser
+
+ref over Parser : get correct answer


i think there's a missing sequence diagram here? maybe you can include the sequence diagram (esp for ref), such as the get correct answer?

Elyovs · 2024-04-03T05:31:51Z

docs/team/img/Results.puml

+
+box Results #EB9999
+participant "topicResults:Results" as Results #FE2727
+participant "allResults:ResultsList" as ResultsList #FE2727


i think you need to hide the class at the bottom of the diagram?

Elyovs · 2024-04-03T05:33:34Z

docs/team/img/Results.puml

+deactivate ResultsList
+
+Ui -->[
+


you may need to deactivate Ui activation in the end after -->[ ?

Elyovs · 2024-04-03T05:38:34Z

docs/team/img/Results.puml

+Ui -->[
+
+destroy Results
+destroy Parser


maybe you should also destroy allResults?

Elyovs · 2024-04-03T05:41:37Z

docs/DeveloperGuide.md

+and proceeds to start a game with their chosen topic.
+
+The following shows the class diagram for `topicList`:
+![TopicList class diagram](./team/img/TopicList_Topic_class_diagram.png)


class may need to add + and - to show public and private?

Elyovs · 2024-04-03T05:43:20Z

docs/DeveloperGuide.md

+The solution feature is facilitated by `Parser#processSolutionCommand`, which is called by `Parser#parseCommand`
+
+> **OVERVIEW:**
+> ![Solution sequence diagram](./team/img/Solution.png)


in alt, maybe need to add [else] sign?

Elyovs · 2024-04-03T05:44:05Z

docs/DeveloperGuide.md

+The solution feature is facilitated by `Parser#processSolutionCommand`, which is called by `Parser#parseCommand`
+
+> **OVERVIEW:**
+> ![Solution sequence diagram](./team/img/Solution.png)


after calling the methods, i think you may need to add return arrow, even if void?

Elyovs · 2024-04-03T05:47:00Z

docs/DeveloperGuide.md

+The solution feature is facilitated by `Parser#processSolutionCommand`, which is called by `Parser#parseCommand`
+
+> **OVERVIEW:**
+> ![Solution sequence diagram](./team/img/Solution.png)


some method invocation got no name, maybe need to add the method name on it, instead of putting it on the return arrow?

Elyovs · 2024-04-03T05:53:45Z

docs/DeveloperGuide.md

+
+Similarly, the following sequence diagram shows how the
+`AnswerTracker` stores all the user answer inputs:  
+![AnswerTracker sequence diagram](https://via.placeholder.com/100.png?text=Photo)


maybe add the diagram here? its empty?

Elyovs · 2024-04-03T05:54:24Z

docs/DeveloperGuide.md


 ## Glossary

-* *glossary item* - Definition


maybe also update the template here?

nicknamenic · 2024-04-03T05:30:24Z

docs/DeveloperGuide.md

+and proceeds to start a game with their chosen topic.
+
+The following shows the class diagram for `topicList`:
+![TopicList class diagram](./team/img/TopicList_Topic_class_diagram.png)


Shouldn't there be no c?

nicknamenic · 2024-04-03T05:33:27Z

docs/DeveloperGuide.md

+and proceeds to start a game with their chosen topic.
+
+The following shows the class diagram for `topicList`:
+![TopicList class diagram](./team/img/TopicList_Topic_class_diagram.png)


Shouldn't there be a + or - to indicate whether the method is private, public or protected?

nicknamenic · 2024-04-03T05:42:18Z

docs/DeveloperGuide.md

+and proceeds to start a game with their chosen topic.
+
+The following shows the class diagram for `topicList`:
+![TopicList class diagram](./team/img/TopicList_Topic_class_diagram.png)


Shouldn't the colons be standardized?

nicknamenic · 2024-04-03T05:51:31Z

docs/DeveloperGuide.md

+The solution feature is facilitated by `Parser#processSolutionCommand`, which is called by `Parser#parseCommand`
+
+> **OVERVIEW:**
+> ![Solution sequence diagram](./team/img/Solution.png)


Perhaps you can include the else condition in the second box?

nicknamenic · 2024-04-03T05:56:06Z

docs/DeveloperGuide.md

+![ResultsList sequence diagram](./team/img/Results.png)
+> **Note:** The lifeline for Parser and Results should end
+> at the destroy marker (X) but due to a limitation of PlantUML,
+> the lifeline reaches the end of the diagram.
+
+Similarly, the following sequence diagram shows how the
+`AnswerTracker` stores all the user answer inputs:  
+![AnswerTracker sequence diagram](https://via.placeholder.com/100.png?text=Photo)


Shouldn't the photo appear?

nicknamenic · 2024-04-03T05:59:12Z

docs/DeveloperGuide.md

-## Acknowledgements
-
-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
-
 ## Design & implementation

 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}


Shouldn't this line be deleted?

YoengKokLeong · 2024-04-03T05:45:50Z

docs/DeveloperGuide.md

+Step 1. The user launches the application for the first time,
+and proceeds to start a game with their chosen topic.
+
+The following sequence diagram shows how the `Results` for


Hi, the method calling solid line arrow for "new Results()" seems to not be pointing to the start of the activation bar.

YoengKokLeong · 2024-04-03T05:49:26Z

docs/DeveloperGuide.md

+
+Similarly, the following sequence diagram shows how the
+`AnswerTracker` stores all the user answer inputs:  
+![AnswerTracker sequence diagram](https://via.placeholder.com/100.png?text=Photo)


I think the photo is not loaded correctly on the DG site

YoengKokLeong · 2024-04-03T05:49:52Z

docs/DeveloperGuide.md

+
+Step 3. The user now wants to view their results by executing
+the `results` command.  
+![Results command sequence diagram](https://via.placeholder.com/100.png?text=Photo)


Photo not loaded for this as well

YoengKokLeong · 2024-04-03T05:52:05Z

docs/DeveloperGuide.md

+and proceeds to start a game with their chosen topic.
+
+The following shows the class diagram for `topicList`:
+![TopicList class diagram](./team/img/TopicList_Topic_class_diagram.png)


Class diagram for topicList should not have the C icon present, as I don't think it follows the standards stated.

YoengKokLeong · 2024-04-03T05:53:32Z

docs/DeveloperGuide.md

+and proceeds to start a game with their chosen topic.
+
+The following shows the class diagram for `topicList`:
+![TopicList class diagram](./team/img/TopicList_Topic_class_diagram.png)


Missing of indication of private and public methods/ variables with "+/-" etc

ZMinghuiZ

Generally good job! The notations of the diagrams seems to be compliant with the convention covered in the course. Maybe could add more diagram to enhance the developer guide understanding?

ZMinghuiZ · 2024-04-04T03:27:06Z

docs/DeveloperGuide.md

+
+The following sequence diagram shows how the `Results` for
+one question set is added to the `ResultsList`:  
+![ResultsList sequence diagram](./team/img/Results.png)


I like the use of ref block to make the sequence diagram more concise and readable. Good use of different color to differentiate Logic and Result👍

ZMinghuiZ · 2024-04-04T03:32:49Z

docs/DeveloperGuide.md

+The following sequence diagram shows how the `Results` for
+one question set is added to the `ResultsList`:  
+![ResultsList sequence diagram](./team/img/Results.png)
+> **Note:** The lifeline for Parser and Results should end


Perhaps add an object to indicate who invoked `printChosenTopic` method would make the diagram more clear.

ZMinghuiZ · 2024-04-04T03:43:45Z

docs/DeveloperGuide.md

+The following sequence diagram shows how the `Results` for
+one question set is added to the `ResultsList`:  
+![ResultsList sequence diagram](./team/img/Results.png)
+> **Note:** The lifeline for Parser and Results should end


Perhaps add the explanation of the ref block would make it more comprehensible?

ZMinghuiZ · 2024-04-04T03:46:53Z

docs/DeveloperGuide.md

+Step 1. The user launches the application for the first time,
+and proceeds to start a game with their chosen topic.
+
+The following shows the class diagram for `topicList`:


Perhaps add a line separator here to make the class diagram occupy a dedicated space would allow the format to be more readable.

ZMinghuiZ · 2024-04-04T03:50:52Z

docs/DeveloperGuide.md

+The explain feature either prints the explanation to 1 question or all questions in 1 topic.
+
+The explain feature is facilitated by `Parser#processExplanationCommand`, which is called by `Parser#parseCommand`
+


Perhaps add some diagram here would allow better understanding of developers?

anneleong · 2024-04-04T04:13:58Z

docs/DeveloperGuide.md

+The solution feature is facilitated by `Parser#processSolutionCommand`, which is called by `Parser#parseCommand`
+
+> **OVERVIEW:**
+> ![Solution sequence diagram](./team/img/Solution.png)


The sequence diagram has many parts and may be slightly hard to understand initially, it would be good if you could break it down into parts when explaining, means showing just small sections of the sequence diagram

anneleong · 2024-04-04T04:20:37Z

docs/DeveloperGuide.md

+Step 2a: `Parser#processExplainCommand` first checks the number of parameters in the user command
+by calling `Parser#checkIfTwoParameters`.
+The, further processing of parameters is done by calling `Parser#getTopicOrQuestionNum`.
+This is facilitated by calling `QuestionsListByTopic#getQuestionSet` to get all questions in the specified topic.


maybe you could swap 2b and 2a since 2a is more related to step 3

anneleong · 2024-04-04T04:23:58Z

docs/DeveloperGuide.md

+
+### Libraries
+
+1. Display formatted tables in the CLI - [ASCII TABLES](https://bethecoder.com/applications/products/asciiTable.action)


good that you included your references :)

anneleong · 2024-04-04T04:27:55Z

docs/DeveloperGuide.md

-|--------|----------|---------------|------------------|
-|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
+| Version | As a ...                       | I want to ...                                        | So that I can ...                                                      |


maybe you could categorise the user stories by priorities and include their priority into the userstories table

Joellimjr · 2024-04-04T07:34:12Z

docs/DeveloperGuide.md

+
+2. Topic selection menu and testing mode progress bar - [ProgressBar](https://github.com/ctongfei/progressbar)
+
+### References


Maybe remove references if there is nothing to add here

Joellimjr · 2024-04-04T07:35:40Z

docs/DeveloperGuide.md

+
+2. Topic selection menu and testing mode progress bar - [ProgressBar](https://github.com/ctongfei/progressbar)
+
+### References

 ## Instructions for manual testing



Remember to remove this default text

Joellimjr · 2024-04-04T07:38:05Z

docs/DeveloperGuide.md

+The solution feature is facilitated by `Parser#processSolutionCommand`, which is called by `Parser#parseCommand`
+
+> **OVERVIEW:**
+> ![Solution sequence diagram](./team/img/Solution.png)


Consider removing getters and setters as their functions are quite obvious

Joellimjr · 2024-04-04T07:41:19Z

docs/DeveloperGuide.md

+and proceeds to start a game with their chosen topic.
+
+The following shows the class diagram for `topicList`:
+![TopicList class diagram](./team/img/TopicList_Topic_class_diagram.png)


Consider reformatting such that the text is above the diagram for clarity

vibes-863

Overall nice work!

vibes-863 · 2024-04-04T07:40:58Z

docs/DeveloperGuide.md

+
+Similarly, the following sequence diagram shows how the
+`AnswerTracker` stores all the user answer inputs:  
+![AnswerTracker sequence diagram](./team/img/AnswerTracker.png)


I like that you have tried to differentiate between Logic and Answers using the different colors, but I think that it makes it harder to read the diagram as some content is between the colored boxes.

Maybe consider just coloring the class instance boxes and adding a legend on the side.

vibes-863 · 2024-04-04T07:42:45Z

docs/DeveloperGuide.md

+
+The following sequence diagram shows how the `Results` for
+one question set is added to the `ResultsList`:  
+![ResultsList sequence diagram](./team/img/Results.png)


Good use of ref block to help improve readability!

vibes-863 · 2024-04-04T07:47:53Z

docs/DeveloperGuide.md

+
+The following sequence diagram shows how the `Results` for
+one question set is added to the `ResultsList`:  
+![ResultsList sequence diagram](./team/img/Results.png)


Wouldn't it be better to use opt block instead of alt block as there is only one path?

vibes-863 · 2024-04-04T07:53:57Z

docs/DeveloperGuide.md

+The solution feature is facilitated by `Parser#processSolutionCommand`, which is called by `Parser#parseCommand`
+
+> **OVERVIEW:**
+> ![Solution sequence diagram](./team/img/Solution.png)


Have you maybe forgot to add [else] int the alt block?

Final UG

UI test fix

nichyjt

Hi team,

Overall good job at making the DG!

Please take note of the syntax issues with the diagrams and
There are some sections of the DG that are incomplete. Please finish them.
Most of the diagrams are OK in complexity, but consider scaling down some of the sequence diagrams.
Remember: guiding principle from the website...

Keep diagrams simple. The aim is to make diagrams comprehensible, not necessarily comprehensive.

Please do refer to AB3 DG for inspiration and tips on how to better structure and format your content.

nichyjt · 2024-04-07T03:28:51Z

docs/DeveloperGuide.md

+> **Note:** The lifeline for Parser and Results should end
+> at the destroy marker (X) but due to a limitation of PlantUML,
+> the lifeline reaches the end of the diagram.


It should be possible to remove the bubbles at the bottom with some tinkering of PlantUML if I am not wrong. Alternatively, you may also crop the image.

nichyjt · 2024-04-07T03:31:38Z

docs/DeveloperGuide.md

+
+The following sequence diagram shows how the `Results` for
+one question set is added to the `ResultsList`:  
+![ResultsList sequence diagram](./team/img/Results.png)


Activation bar might not have been terminated correctly. Missing the border line at the bottom!

nichyjt · 2024-04-07T03:35:52Z

docs/DeveloperGuide.md

+
+Similarly, the following sequence diagram shows how the
+`AnswerTracker` stores all the user answer inputs:  
+![AnswerTracker sequence diagram](./team/img/AnswerTracker.png)


Similarly, the activation bar here was not terminated correctly

nichyjt · 2024-04-07T03:37:27Z

docs/DeveloperGuide.md

+
+The following sequence diagram shows how the `Results` for
+one question set is added to the `ResultsList`:  
+![ResultsList sequence diagram](./team/img/Results.png)


See if you can get reference frames to be opaque.

For readability

To adhere to textbook

Recall the textbook's notation on reference frames. This is a repeated issue for all your sequence diagrams

nichyjt · 2024-04-07T03:40:44Z

docs/DeveloperGuide.md

+
+Step 3. The user now wants to view their results by executing
+the `results` command.  
+![Results command sequence diagram](./team/img/ViewResults.png)


A few issues:

Unterminated activation bar for Parser

Ref blocks not opaque

The complexity is on the slightly higher side for this sequence diagram. You might want to consider refactoring

nichyjt · 2024-04-07T03:47:42Z

docs/DeveloperGuide.md

+and proceeds to start a game with their chosen topic.
+
+The following shows the class diagram for `topicList`:
+![TopicList class diagram](./team/img/TopicList_Topic_class_diagram.png)


Most of your peers have identified the bigger issues of the diagram, like the class circle and the access modifiers.

nichyjt · 2024-04-07T03:57:09Z

docs/DeveloperGuide.md

Consider adding in a table of contents, similar to the reference Address Book DG

nichyjt · 2024-04-07T04:05:49Z

docs/DeveloperGuide.md

+
+2. Topic selection menu and testing mode progress bar - [ProgressBar](https://github.com/ctongfei/progressbar)
+
+### References

 ## Instructions for manual testing


Please include details about manual testing here

nichyjt · 2024-04-07T04:13:01Z

docs/DeveloperGuide.md

+> **OVERVIEW:**
+> ![Solution sequence diagram](./team/img/Solution.png)
+
+> > **Note:** The lifeline for Parser and Results should end


Might be intentional, but the double quote makes the rendering seem buggy (space between 'overview' and the note.

Add hardcoded questions

Fix formatting for PPP

Update ppp

…into DGv2

Fix formatting errors UG, DG

Update website

…into DGv2

fix format in UG

…into DGv2

Fix clear bug

…into DGv2

Remove unnecessary code

# Conflicts: # src/main/java/seedu/duke/Parser.java

Merge branch 'master' of https://github.com/hongyijie06/tp

…into DGv2

Fix ^D bug in sayHi()

JeffinsonDarmawan added a commit to JeffinsonDarmawan/tp that referenced this pull request Mar 22, 2024

Merge pull request nus-cs2113-AY2324S2#55 from JeffinsonDarmawan/master

8483e62

Added more loggers

yeozongyao pushed a commit to yeozongyao/tp that referenced this pull request Apr 1, 2024

Merge pull request nus-cs2113-AY2324S2#55 from Joshuahoky/master

7ace354

Update User Guide

Elyovs reviewed Apr 3, 2024

View reviewed changes

nicknamenic reviewed Apr 3, 2024

View reviewed changes

YoengKokLeong reviewed Apr 3, 2024

View reviewed changes

ZMinghuiZ reviewed Apr 4, 2024

View reviewed changes

anneleong reviewed Apr 4, 2024

View reviewed changes

Joellimjr reviewed Apr 4, 2024

View reviewed changes

vibes-863 reviewed Apr 4, 2024

View reviewed changes

songyuew and others added 4 commits April 4, 2024 23:42

Final UG

52c0d0c

Merge pull request #97 from songyuew/master

021b22f

Final UG

UI test fix

3ef358d

Merge pull request #98 from songyuew/master

9f14ed5

UI test fix

nichyjt reviewed Apr 7, 2024

View reviewed changes

NGXZS and others added 15 commits April 9, 2024 18:34

Fix UserGuide format issues

6435b39

Add createQuestions function and dataset

36f4109

Fix checkstyle errors, code clean up in Parser.java

2cde8d2

Add testing code for question dataset

529bcf1

Fix handleException() to pass github checks

3ea46cc

Remove testing code

009f971

Merge branch 'master' of https://github.com/AY2324S2-CS2113-F15-1/tp

8dc71f5

Add hardcoded questions format

c893409

merge with upstream

2541605

Merge with upstream

8cf7989

Add sample questions

93ce583

Fix checkstyle errors

cdb8bdc

Merge pull request #149 from NGXZS/PED-bugs

affeb35

Add hardcoded questions

Update UG to avoid reader confusion

d2faa04

Add steps for adding hardcoded questions

35d5bce

NGXZS and others added 30 commits April 15, 2024 22:56

Merge pull request #207 from NGXZS/DGv2

873a08c

Fix formatting for PPP

Update ppp

1c60262

Fix minor formatting in PPP

f5de063

Merge pull request #208 from yuhengr/add-docs-5

a387ab5

Update ppp

Merge branch 'master' of https://github.com/AY2324S2-CS2113-F15-1/tp …

63ed2f4

…into DGv2

Fix minor formatting errors in DG, UG

5bdba20

Add newline after Examples: in UG

503639c

Merge branch 'master' of https://github.com/AY2324S2-CS2113-F15-1/tp

6d45452

Merge pull request #209 from NGXZS/DGv2

85a71ce

Fix formatting errors UG, DG

Add website home page

80960a8

fix format in UG

43990f6

Merge pull request #210 from cyhjason29/update-Website

dcdfd66

Update website

Merge branch 'master' of https://github.com/AY2324S2-CS2113-F15-1/tp …

3094590

…into DGv2

Merge pull request #211 from NGXZS/DGv2

11fd99e

fix format in UG

Add formatting

4259a58

Add Ctrl C exception handler for sayHi() in Player2113.java

c736b00

Merge branch 'master' of https://github.com/AY2324S2-CS2113-F15-1/tp …

0c64344

…into DGv2

Fix clear bbug, mark topic as NotAttempted after clear

921ad5e

Move printTopicList() to original place in Player2113

5cb5c84

Add javadoc

0056522

Merge pull request #212 from NGXZS/DGv2

3f0c890

Fix clear bug

Remove redundant variables in Parser, Ui

873ac67

Reformat Storage

94ddf54

Merge branch 'master' of https://github.com/AY2324S2-CS2113-F15-1/tp …

100a998

…into DGv2

Merge pull request #213 from NGXZS/DGv2

6838e87

Remove unnecessary code

Merge branch 'master' of https://github.com/hongyijie06/tp

a11224e

# Conflicts: # src/main/java/seedu/duke/Parser.java

Merge pull request #214 from hongyijie06/master

3cf419c

Merge branch 'master' of https://github.com/hongyijie06/tp

Fix ^D error for sayHi()

165fcd4

Merge branch 'master' of https://github.com/AY2324S2-CS2113-F15-1/tp …

4e129d3

…into DGv2

Merge pull request #215 from NGXZS/DGv2

9673b22

Fix ^D bug in sayHi()

		The explain feature either prints the explanation to 1 question or all questions in 1 topic.

		The explain feature is facilitated by `Parser#processExplanationCommand`, which is called by `Parser#parseCommand`


		### Libraries

		1. Display formatted tables in the CLI - [ASCII TABLES](https://bethecoder.com/applications/products/asciiTable.action)


		2. Topic selection menu and testing mode progress bar - [ProgressBar](https://github.com/ctongfei/progressbar)

		### References

[CS2113-F15-1] Player2113 #55

Are you sure you want to change the base?

[CS2113-F15-1] Player2113 #55

Conversation

songyuew commented Mar 8, 2024

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

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

ZMinghuiZ 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vibes-863 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

nichyjt 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