[CS2113-W11-2] WildWatch by woodenclock · Pull Request #5 · nus-cs2113-AY2324S1/tp

woodenclock · 2023-10-04T03:26:01Z

Created Team Repo for tp.
Wildwatch is a program for recording down individual wildlife in a wildlife reserve via the Command Line Interface (CLI).

…lashcard-support Add flashcard support

Musfirahe0556596

Good but there are a few violation in code quality to consider!

Musfirahe0556596 · 2023-10-28T09:23:16Z

+            } else if (inputBuffer.equals("help")) {  //User request "help"
+                Ui.printHorizontalLines();
+                Ui.helpRequestMessagePrinter();
+                Ui.printHorizontalLines();
+                HelpCommand.printHelpMessage();
+            } else {
+                Ui.printHorizontalLines();
+                ErrorHandler.handleError(inputBuffer);
+                Ui.printHorizontalLines();


Could be further abstracted to improve code quality.

Musfirahe0556596 · 2023-10-28T09:23:43Z

+     * Returns input of the user from the console.
+     * @return The user's input as a trimmed string.


Empty line between description and parameter section.

Musfirahe0556596 · 2023-10-28T09:23:54Z

+        System.out.println("Creating new file...\nFile created successfully.");
+    }
+
+    public static void printEntry(int nthEntry) {


Do remember to include JavaDoc comments, along with other methods too!

Musfirahe0556596 · 2023-10-28T09:24:23Z

+     */
+    public static void findEntry(String inputBuffer) {
+        boolean hasMatch = false;
+        String matchingWord = inputBuffer.substring(inputBuffer.indexOf("find") + 5).trim();


'Magic number' 5 - Could be placed as a named constant.

Musfirahe0556596 · 2023-10-28T09:24:44Z

+     * @param entry
+     * @return String
+     * @throws IOException when there is problem with formatting the task


Punctuation behind each parameter description.

Musfirahe0556596 · 2023-10-28T09:24:59Z

+    /**
+     * Checks if file exists. Opens file if the file exists.
+     *
+     * @return true if file exists; false if not


Punctuation behind each parameter description.

J0shuaLeong · 2023-11-01T04:51:54Z

+For the diagram below, the command `add D/02-03-23 S/Annam Leaf Turtle N/Ariel R/Injured left flipper` has been substituted by `input`. 
+
+![](diagrams/AddSequenceDiagram.svg)
+


AddCommand should be destroyed after being executed and returns a command result.

J0shuaLeong · 2023-11-01T04:55:55Z

@@ -1,38 +1,212 @@
-# Developer Guide
+# WildWatch Developer Guide 🦏
+


Overall good job. The DG has more to be completed so I don't have much comments to make. No issues with structure and flow. Nice that you have a table of contents and an option to take reader back to top. Cute emojis as well :). Don't forget to include class diagrams as well. I am sure you guys have plans to add in individual commands, explaining the design considerations and implementations.

spaceman03

Great job! I believe that you all will add more UML diagrams into the DG such as class diagrams and not just sequence diagrams.

spaceman03 · 2023-11-02T09:14:25Z

+
+### System Architecture
+
+![System Architecture](https://github.com/AY2324S1-CS2113T-W11-2/tp/assets/69474977/90309a3c-f784-4ffb-8eef-65735c05ec52)


Perhaps you could remove the class names below as it is already mentioned above.

spaceman03 · 2023-11-02T09:16:29Z

+### Legend
+
+| Symbol         | Meaning                                                     |
+| -------------- |------------------------------------------------------------ |
+| ❗ IMPORTANT   | These are important instructions that you should follow.   |
+| ✏ Note   | These are important details that you should take note of.   |
+| ⬆ Back to top  | Click to scroll back up to the `Table of Contents`.         |
+| 🐵 🦊 🦁      | Animals indicate you have reached a new section.            |
+
+[⬆ Back to top](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------------------------


I like this session that shows the different legends used in the DG.

spaceman03 · 2023-11-02T09:21:14Z

+
+[⬆ Back to top](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#table-of-contents)
+


Nice to see that you have a "back to top" button after each section.

spaceman03 · 2023-11-02T09:23:55Z

+### How to use the Developer Guide  
+- Are you new here?  
+No worries, head to the [Quick Start](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#quick-start-) page.
+- Lost among the pages?  
+Head to the [Table of Contents](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#table-of-contents) to look for the right pages.  
+- Need help with the functionalities?  
+Head to the [Features](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#features-) page for detailed guidance.  
+- Do you have a question for us?  
+Head to the [FAQ](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#faq-) page.  
+- Do you want a concise summary of all functionalities?  
+Head to the [Command Summary](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#command-summary-) page for a summary of all commands.
+- Not sure what that word meant?  
+Head to the [Glossary](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#glossary-) page for its meaning.  


This section is great! It navigates the user to the respective section of the DG.

TriciaBK · 2023-11-02T09:23:28Z

+- `FileHandler`: A class that saves and retrieves all the wildlife data from the local storage

-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+![Architecture Sequence Diagram](https://github.com/AY2324S1-CS2113T-W11-2/tp/assets/69474977/6bea5165-aa78-4b3e-baf0-2e9ced109161)  


Is there an additional return from command to execute or is command returning twice to execute?

TriciaBK · 2023-11-02T09:28:14Z

+
+### Command component
+![](images/AddSequenceDiagram.png)
+


yepp^ and what do the 'a's above return arrows represent?

TriciaBK · 2023-11-02T09:35:15Z

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


+### Parser component 


Would be good to provide a sequence diagram for Parser too

TriciaBK · 2023-11-02T09:39:23Z

+|v1.0|zoo clerk|add an animal entry|record the animals in the zoo, and refer to them afterwards|
+|v1.0|zoo clerk|delete an animal entry|remove redundant or invalid animal entry|
+|v1.0|zoo clerk|list all the entries|see what entries I have entered previously, and refer to them|
 |v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|


How about other things like saving, editing, and summarising?

TriciaBK · 2023-11-02T09:41:21Z

+
+[⬆ Back to top](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#table-of-contents)
+
+--------------------------------------------------------------------------------------------------------------------------------------


Overall DG is incomplete, well formatted and easy to understand but insufficient details and diagrams

kaijie0102

Overall, UI is really neat and clear.

However, general sequence diagram has some common notation errors, but could be fix really easily

kaijie0102 · 2023-11-03T03:19:09Z

-# Developer Guide
+# WildWatch Developer Guide 🦣
+
+## Table of Contents  


I really like your table of content, it is something that I would like to have in my own DG

kaijie0102 · 2023-11-03T03:21:09Z

+
+### System Architecture
+
+![System Architecture](https://github.com/AY2324S1-CS2113T-W11-2/tp/assets/69474977/90309a3c-f784-4ffb-8eef-65735c05ec52)


I like that how clean and clear your architecture diagram is. Not only are the fonts just right, the choice of colours of arrows make the interaction really obvious

kaijie0102 · 2023-11-03T03:25:54Z

+![Architecture Sequence Diagram](https://github.com/AY2324S1-CS2113T-W11-2/tp/assets/69474977/6bea5165-aa78-4b3e-baf0-2e9ced109161)  

-## Design & implementation
+The **_Generic Sequence Diagram_** above shows a shows how the components in the architecture interact with each other for a generic command input in WildWatch.  


Is activation bar too long?

See Common Notation Error in week 10 Sequence Diagram

kaijie0102 · 2023-11-03T03:29:04Z

+![Architecture Sequence Diagram](https://github.com/AY2324S1-CS2113T-W11-2/tp/assets/69474977/6bea5165-aa78-4b3e-baf0-2e9ced109161)  

-## Design & implementation
+The **_Generic Sequence Diagram_** above shows a shows how the components in the architecture interact with each other for a generic command input in WildWatch.  


Could you be missing an entry point to the sequence diagram? It seems like the entry point comes from the Execute class

but in the docs its said that main was the entry point

kaijie0102 · 2023-11-03T03:31:22Z

+![Architecture Sequence Diagram](https://github.com/AY2324S1-CS2113T-W11-2/tp/assets/69474977/6bea5165-aa78-4b3e-baf0-2e9ced109161)  

-## Design & implementation
+The **_Generic Sequence Diagram_** above shows a shows how the components in the architecture interact with each other for a generic command input in WildWatch.  


Perhaps, It might be better to seperate error handling using checkError() method from the construction of a Parser object?

kaijie0102 · 2023-11-03T03:35:02Z

+![Architecture Sequence Diagram](https://github.com/AY2324S1-CS2113T-W11-2/tp/assets/69474977/6bea5165-aa78-4b3e-baf0-2e9ced109161)  

-## Design & implementation
+The **_Generic Sequence Diagram_** above shows a shows how the components in the architecture interact with each other for a generic command input in WildWatch.  


Is the activation bar broken?

See Common Notation Error in week 10 Sequence Diagram

kaijie0102 · 2023-11-03T03:38:53Z

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


+### Parser component 


perhaps "a" could be replaced with addCommand object or something that reflects "a" being a Command

kaijie0102 · 2023-11-03T03:41:51Z

+| ⬆ Back to top  | Click to scroll back up to the `Table of Contents`.         |
+| 🐵 🦊 🦁      | Animals indicate you have reached a new section.            |
+
+[⬆ Back to top](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#table-of-contents)


I really like your back to top buttons! Will incorporate this

…aster Update

checked through checkstyleMain

Fix indentation error in HelpCommand.java

Made a draft for Manual Testing section in DG

…r delete function #151

Update ExportCommand

Added comments for some class method

update imaginarys96.md

This reverts commit 70ae3c9.

This reverts commit 0b8eaf2.

Updated tangzhenen.md

update aboutus.md

remove some stuff

Brian030601 pushed a commit to Brian030601/tp that referenced this pull request Oct 13, 2023

Merge pull request nus-cs2113-AY2324S1#5 from wendelinwemhoener/add-f…

314f377

…lashcard-support Add flashcard support

Musfirahe0556596 reviewed Oct 28, 2023

View reviewed changes

J0shuaLeong reviewed Nov 1, 2023

View reviewed changes

spaceman03 reviewed Nov 2, 2023

View reviewed changes

TriciaBK reviewed Nov 2, 2023

View reviewed changes

kaijie0102 suggested changes Nov 3, 2023

View reviewed changes

Brian030601 pushed a commit to Brian030601/tp that referenced this pull request Nov 6, 2023

Merge pull request nus-cs2113-AY2324S1#5 from AY2324S1-CS2113-F11-3/m…

5111380

…aster Update

woodenclock and others added 23 commits November 7, 2023 21:23

Fix indentation error in HelpCommand.java

07fa741

checked through checkstyleMain

Merge pull request #199 from woodenclock/master

e328348

Fix indentation error in HelpCommand.java

Update woodenclock.md

960d0f1

Update woodenclock.md

b0b8846

Update woodenclock.md

ab60692

Update woodenclock.md

e8ff0c3

Update woodenclock.md

d3ec80f

Update woodenclock.md

29e9a02

Update woodenclock.md

6cec181

Update woodenclock.md

940456b

Update woodenclock.md

a14d42d

Update woodenclock.md

dbefad9

Made a draft for Manual Testing section in DG

c9092db

Update woodenclock.md

4910d4f

Merge pull request #200 from imaginarys96/master

741642b

Made a draft for Manual Testing section in DG

Update woodenclock.md

e9d5450

Update woodenclock.md

69c5022

Update UserGuide.md

3f8ff87

Fix bug: [PE-D][Tester B] Failed to further validate yes/no choice fo…

220ee47

…r delete function #151

Update UserGuide.md

a3f2f06

Update UserGuide.md

7954ec4

Enhancement: bye during the delete prompt will exit program

db48ee2

Update UserGuide.md

24149e3

woodenclock and others added 30 commits November 11, 2023 22:17

Update woodenclock.md

838606a

Update ExportCommand

8a8f800

Merge pull request #229 from woodenclock/master

c0869ac

Update ExportCommand

Update woodenclock.md

67f05c9

Update woodenclock.md

49e9837

Update woodenclock.md

5dbed72

added javadoc comments

9ea1a60

Merge remote-tracking branch 'origin/master'

455626a

Merge pull request #230 from imaginarys96/master

30be67b

Added comments for some class method

Update UserGuide.md

ee7e864

Update DeveloperGuide.md

15b4a4d

Update DeveloperGuide.md

9e313c7

Update DeveloperGuide.md

cdfc35b

Update woodenclock.md

eebf88c

Update woodenclock.md

07503d9

Update lctxct.md

5341504

Update lctxct.md

a8eca15

update imaginarys96.md

9a6192e

Merge pull request #231 from imaginarys96/master

0ab3461

update imaginarys96.md

delete command diagram

70ae3c9

Revert "delete command diagram"

0b8eaf2

This reverts commit 70ae3c9.

Revert "Revert "delete command diagram""

722d15d

This reverts commit 0b8eaf2.

Merge remote-tracking branch 'origin/master'

4b90022

updated tangzhenen.md

877ef88

Merge pull request #232 from tangzhenen/master

5969c16

Updated tangzhenen.md

update aboutus.md

4a0244d

Merge pull request #233 from tangzhenen/master

fba3ac2

update aboutus.md

remove some stuff

c89c531

Merge pull request #234 from imaginarys96/master

13d6231

remove some stuff

Update README.md

1c4aa37

		* Returns input of the user from the console.
		* @return The user's input as a trimmed string.

		For the diagram below, the command `add D/02-03-23 S/Annam Leaf Turtle N/Ariel R/Injured left flipper` has been substituted by `input`.

		![](diagrams/AddSequenceDiagram.svg)

		@@ -1,38 +1,212 @@
		# Developer Guide
		# WildWatch Developer Guide 🦏


		### System Architecture

		![System Architecture](https://github.com/AY2324S1-CS2113T-W11-2/tp/assets/69474977/90309a3c-f784-4ffb-8eef-65735c05ec52)


		[⬆ Back to top](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#table-of-contents)

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


		### Parser component


		[⬆ Back to top](https://ay2324s1-cs2113t-w11-2.github.io/tp/DeveloperGuide.html#table-of-contents)

		--------------------------------------------------------------------------------------------------------------------------------------

Uh oh!

Conversation

woodenclock commented Oct 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Musfirahe0556596 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!

spaceman03 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!

kaijie0102 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!

kaijie0102 Nov 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

woodenclock commented Oct 4, 2023 •

edited

Loading

kaijie0102 Nov 3, 2023 •

edited

Loading