[CS2113-T16-1] Libmgr by exetr · Pull Request #38 · nus-cs2113-AY2122S1/tp

exetr · 2021-09-30T08:26:01Z

Libmgr helps librarians to streamline the process of managing the book catalogues within their library.

yanjia1777 · 2021-10-27T03:13:19Z

 ## Design & implementation

-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+This section provides an overview of the design architecture and implementation of Libmgr. Each sub-section provides a detailed explanation of the design of each component


Missing introduction and explanation of program?

yanjia1777 · 2021-10-27T03:18:08Z

+### Entrypoint of Libmgr
+
+![InitializationMainFunction](img/InitializationMainFunctionSequence.png)
+


Shouldn't print(LOGO) and print(WELCOME) create another activation bar of the class?

yanjia1777 · 2021-10-27T03:22:22Z

+The commands component consists of a 'commands' package which holds a main Parser class to execute all the commands, as well as 
+individual class files, each corresponding to a specific command, that inherit from an abstract command class.
+
+![ParserAndCommandClassDiagram](img/ParserAndCommandClassDiagram.png)


Diagram is too small, unable to read the words in it

yanjia1777 · 2021-10-27T03:27:39Z

+
+The data component consists of a `data` package which holds classes that aim to allow the categorisation of items into different types.
+
+![ItemsClassDiagram](img/ItemsClassDiagram.png)


Labels are vague, don't know what they are trying to represent

mayankp291 · 2021-10-28T01:18:19Z

+
+### Entrypoint of Libmgr
+
+![InitializationMainFunction](img/InitializationMainFunctionSequence.png)


Adding a User bar on the left makes it easier for the reader to know where the program flow begins.

mayankp291 · 2021-10-28T01:22:56Z

+The commands component consists of a 'commands' package which holds a main Parser class to execute all the commands, as well as 
+individual class files, each corresponding to a specific command, that inherit from an abstract command class.
+
+![ParserAndCommandClassDiagram](img/ParserAndCommandClassDiagram2.png)


The class diagram seems to have too much information and as a result the text size is very small, it looks blurry. Maybe try dividing the diagram into a few sub-sections and elaborating them.

In addition to this, it may not be necessary to list out every single parameter and method. U could omit out certain methods that might be redundant.

mayankp291 · 2021-10-28T01:27:40Z

+
+### Data Package
+
+The data component consists of a `data` package which holds classes that aim to allow the categorisation of items into different types.


Adding more explanation about the technical workings of the module would help and giving a brief description of how classes interact.

mayankp291 · 2021-10-28T01:29:11Z

+### Entrypoint of Libmgr
+
+![InitializationMainFunction](img/InitializationMainFunctionSequence.png)


No description provided for Entrypoint of the program

mayankp291 · 2021-10-28T01:30:41Z

+### Searching feature of Libmgr
+
+![SearchFunction](img/SearchFunctionSequence.png)


No description provided for this section

mayankp291 · 2021-10-28T01:31:26Z


 ## Design & implementation

-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+This section provides an overview of the design architecture and implementation of Libmgr. Each sub-section provides a detailed explanation of the design of each component


Missing table of contents

williamlamjy · 2021-10-28T04:38:39Z

@@ -0,0 +1,151 @@
+@startuml


this seq diagram is way too big and with too many sections. The font is too small and most of the details is really hard to see. Maybe u could simplify the diagram into many different diagrams. The first diagram could have the basic entry to the if-else statements and subsequently u can separate the 4 cases into 4 separate diagrams.

williamlamjy · 2021-10-28T04:41:32Z

+The commands component consists of a 'commands' package which holds a main Parser class to execute all the commands, as well as 
+individual class files, each corresponding to a specific command, that inherit from an abstract command class.
+
+![ParserAndCommandClassDiagram](img/ParserAndCommandClassDiagram2.png)


In addition to this, it may not be necessary to list out every single parameter and method. U could omit out certain methods that might be redundant.

serenakemono · 2021-10-28T06:12:41Z

-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+This section provides an overview of the design architecture and implementation of Libmgr. Each sub-section provides a detailed explanation of the design of each component

+### Architecture Diagram


Would be good to include an architecture diagram of the overall program. :)

serenakemono · 2021-10-28T06:26:57Z

+
+### Searching feature of Libmgr
+
+![SearchFunction](img/SearchFunctionSequence.png)


It seems like this is a bit too deeply nested. May be you can consider using guard clauses to make the main path clearer.

serenakemono · 2021-10-28T06:40:12Z

+### Commands Package
+
+The commands component consists of a 'commands' package which holds a main Parser class to execute all the commands, as well as 
+individual class files, each corresponding to a specific command, that inherit from an abstract command class.


Can consider using code format of some words like Parser.

serenakemono · 2021-10-28T06:43:19Z

+
+#### Edit Command 
+
+The Edit Command class handles the functionality to change a specific detail of an item in the catalogue.


There could be a little bit more explanation about the logic here based on the detailed sequence diagram below. One point that I can think of would be different instances eg magazine, audio that the command can edit,

weidak

Overall good effort on the developer guide! 👍 Keep up the good work :D

weidak · 2021-10-29T06:14:36Z

 ## Design & implementation

-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+This section provides an overview of the design architecture and implementation of Libmgr. Each sub-section provides a detailed explanation of the design of each component


There's a missing architecture diagram after this statement, and more information can be provided on the overall design of the application.

weidak · 2021-10-29T06:16:42Z

+
+### Entrypoint of Libmgr
+
+![InitializationMainFunction](img/InitializationMainFunctionSequence.png)


The method calls are missing for the methods outside of the 'loop' block.

I think the deletion cross is on top of the activation bar for Command and maybe it can be moved down slightly :D

There should be a self-invocation method (inner activation bar) here as well.

weidak · 2021-10-29T06:19:59Z

+
+### Searching feature of Libmgr
+
+![SearchFunction](img/SearchFunctionSequence.png)


I believe this was to ensure clarity of the search functionality of the implementation. However, would it be better if you were to extract these out and put them as reference frames? I believe they are very similar in terms of each if-else loop so 1 arbitrary reference frame can bring the idea across clearly without a huge UML Diagram 👍

weidak · 2021-10-29T06:23:54Z

+The commands component consists of a 'commands' package which holds a main Parser class to execute all the commands, as well as 
+individual class files, each corresponding to a specific command, that inherit from an abstract command class.
+
+![ParserAndCommandClassDiagram](img/ParserAndCommandClassDiagram2.png)


As mentioned previously by another reviewer, I think maybe omitting the methods and attributes would be better for clarity and understanding of the picture because right now I think its overwhelming to the users to read.

weidak · 2021-10-29T06:27:17Z

+
+The Edit Command class handles the functionality to change a specific detail of an item in the catalogue.
+
+![EditCommandSequence](img/EditCommandSequence.png)


Similarly to my comment above, I believe you can put these alt paths into smaller arbitrary reference frames to make it clearer to the readers and this makes the diagram less overwhelming in general.

Fix broken table of content links

…JUnit testing are only partially done.

Updated the search feature to intake multiple parameter

Update documantation

Add error handling in extractArgs for malformed inputs

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

…tructors for all items

…into branch-storage

Update UML diagrams in DG

Add authorship and fix some typos

Update UG

Created PPP for Silin, Updated sequence diagram for search function

Fix typo in DG

Fix documentation typos

Add one last user story

Update PPP and minor change

Fix command summary

Update PPP for Avellin

yanjia1777 reviewed Oct 27, 2021

View reviewed changes

mayankp291 reviewed Oct 28, 2021

View reviewed changes

williamlamjy reviewed Oct 28, 2021

View reviewed changes

serenakemono reviewed Oct 28, 2021

View reviewed changes

weidak reviewed Oct 29, 2021

View reviewed changes

exetr and others added 25 commits October 31, 2021 20:40

Fix coding standard violations

905535f

Merge pull request #169 from exetr/master

3f1de2d

Fix broken table of content links

Add user guide command summary

bdc14a4

Add to user guide command summary

06481d8

Update outdated expected outputs in user guide

191a4b7

Updated the search feature to intake multiple parameter, Javadoc and …

44ca1b8

…JUnit testing are only partially done.

Add higher res version of items class diagram

d1a3b22

Fix formatting errors

a877986

Merge pull request #170 from silinche/master

a709ef7

Updated the search feature to intake multiple parameter

Merge branch 'master' of https://github.com/AY2122S1-CS2113-T16-1/tp

9140beb

Merge pull request #171 from exetr/master

0cce912

Update documantation

Add error handling in extractArgs for malformed inputs

dd4fd1c

Merge pull request #174 from exetr/branch-Parser

1b16242

Add error handling in extractArgs for malformed inputs

Fix bugs + allow edit command to process multi worded IDs

e2b113f

Merge branch 'master' into EditItemDetails

98c4824

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

Add base storage class

ec586cd

Add write catalogue to data JSON file functionality, standardize cons…

87715f0

…tructors for all items

Add functionailty to read json files

41711a5

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

9b569c6

…into branch-storage

Fix merge conflicts

9f075a0

Move data writing logic to JsonFactory class

5d332f0

Merge branch 'deadlineCommand'

3f90c61

Merge branch 'master' of https://github.com/AY2122S1-CS2113-T16-1/tp

1574ce2

Add more JUnit tests for loan and return commands

789a859

Fix coding violation

caa581c

silinche and others added 30 commits November 8, 2021 21:18

Merge branch 'master' of https://github.com/AY2122S1-CS2113-T16-1/tp

96c8107

Merge pull request #233 from avellinwong01/DeveloperGuide

d443b44

Update UML diagrams in DG

Merge branch 'master' into debug

8fb732f

Fix bug in ParserTest

2d6af74

Add instructions for manual testing

460bf64

Merge pull request #236 from dyahnafisah/debug

7b4b7ad

Add authorship and fix some typos

Merge branch 'master' of https://github.com/AY2122S1-CS2113-T16-1/tp

d5bb65b

Merge pull request #237 from exetr/master

05bf580

Update UG

updated ppp

f2f48d4

Merge pull request #235 from silinche/master

03a3c2a

Created PPP for Silin, Updated sequence diagram for search function

Fix typo in DG

2acf1d8

Merge branch 'master' into debug

cad98d1

Merge pull request #238 from dyahnafisah/debug

a38c510

Fix typo in DG

Fix typo

4d3e292

Fix typpos

d05cc34

Merge branch 'master' of https://github.com/AY2122S1-CS2113-T16-1/tp

19a1e25

Merge pull request #239 from exetr/master

b5d84e6

Fix documentation typos

updated readme.md

d9eaa3c

Add one last user story

cff6ab2

Merge branch 'master' of https://github.com/AY2122S1-CS2113-T16-1/tp

04fb2f9

Merge branch 'master' of https://github.com/AY2122S1-CS2113-T16-1/tp

de9d78c

Merge pull request #240 from avellinwong01/master

ec01931

Add one last user story

Update PPP

b87cdcf

Merge pull request #241 from avellinwong01/PPP

be2e21a

Update PPP and minor change

Fix user story

304a76b

Update PPP

0835df3

Merge pull request #242 from dyahnafisah/debug

fff803a

Fix command summary

Merge pull request #243 from avellinwong01/master

94e2d3f

Update PPP for Avellin

Update PPP

db7634c

Update PPP

dda982c

		### Entrypoint of Libmgr

		![InitializationMainFunction](img/InitializationMainFunctionSequence.png)


		The data component consists of a `data` package which holds classes that aim to allow the categorisation of items into different types.

		![ItemsClassDiagram](img/ItemsClassDiagram.png)


		### Data Package

		The data component consists of a `data` package which holds classes that aim to allow the categorisation of items into different types.

		### Searching feature of Libmgr

		![SearchFunction](img/SearchFunctionSequence.png)


		#### Edit Command

		The Edit Command class handles the functionality to change a specific detail of an item in the catalogue.


		The Edit Command class handles the functionality to change a specific detail of an item in the catalogue.

		![EditCommandSequence](img/EditCommandSequence.png)

Uh oh!

Conversation

exetr commented Sep 30, 2021

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!

yanjia1777 Oct 27, 2021 • 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!

williamlamjy Oct 28, 2021 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

williamlamjy Oct 28, 2021 • 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!

Choose a reason for hiding this comment

Uh oh!

weidak left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weidak Oct 29, 2021 • 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!

weidak Oct 29, 2021 • 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

yanjia1777 Oct 27, 2021 •

edited

Loading

williamlamjy Oct 28, 2021 •

edited

Loading

williamlamjy Oct 28, 2021 •

edited

Loading

weidak Oct 29, 2021 •

edited

Loading

weidak Oct 29, 2021 •

edited

Loading