CS2113-T13-3 Classify by ParthGandhiNUS · Pull Request #37 · nus-cs2113-AY2324S2/tp

ParthGandhiNUS · 2024-03-07T05:22:34Z

No description provided.

…yao-defensiveCoding Branch zongyao defensive coding

Mmaxx15 · 2024-04-03T05:20:52Z

+
+#### Implementation and rationale
+
+![InputParsingSequenceDigram](./diagrams/src/InputParsing/InputParsingSequenceDiagram.png)


is there suppose to be a X at the end of lifeline?

Mmaxx15 · 2024-04-03T05:26:50Z

+
+Seen below is an UML diagram of the relevant classes dealing with storage.
+
+![DataStoringUML](./diagrams/src/DataStoring/DateStoring.png)


Good job in adding the UML diagram to help with visualisation

Mmaxx15 · 2024-04-03T05:29:50Z

-{Describe the value proposition: what problem does it solve?}
+Classify serves as an attempt to modernise administrative tasks in education institutes, such as tuition centres or school environments.

 ## User Stories


Could have more user stories which have more specific functionality requirements, current one seems quite vague

Mmaxx15 · 2024-04-03T05:39:39Z

@@ -35,4 +212,21 @@



Nun functional requirements is empty, can specify the constraints under which the system is developed and operated

Mmaxx15 · 2024-04-03T05:41:08Z

 ## Instructions for manual testing

-{Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}
+### Adding a student to the student list


This format seems abit cluttered, could use screenshots to help with visualisation

NicholasTanYY

Overall, the developer guide looks good! It is detailed and sufficient for a developer to understand the main structure of the code. However, please note some of the UML diagram improvements that could be considered. LGTM

NicholasTanYY · 2024-04-03T05:23:53Z

+
+This component ensures that the user parses in commands in a format that makes sense, which will modify the master list.
+
+![InputParsingUML](./diagrams/src/InputParsing/InputParsing.png)


Should the green 'C' be removed from the UML diagram? It seems that the official convention does not use the green 'C'.

Yes, you can refer to the plant UML documentation to remove the circles.

NicholasTanYY · 2024-04-03T05:30:17Z

+
+#### Implementation and rationale
+
+![InputParsingSequenceDigram](./diagrams/src/InputParsing/InputParsingSequenceDiagram.png)


Good try on the sequence diagram! However, should the studentInfo.txt be omitted from the sequence diagram? It would be better if there is a method call to the class which handles the modification of studentInfo.txt instead.

NicholasTanYY · 2024-04-03T05:44:03Z

+
+Please see the diagram below to see how identifying a student works.
+
+![studentIdentification](./diagrams/src/DataStoring/Student%20Identification.png)


Great attempt! I think some of the method calls to various classes seems to be returning multiple objects in the same activation bar, when there is only the initial input method call. Perhaps what you intend to show is 2 activation bars, each returning one object. Or within the same activation bar, there should be some input before there is a return value?

Also should the arrows which show the returning from the activation bar be dotted?

NicholasTanYY · 2024-04-03T05:45:00Z

+
+Seen below is an UML diagram of the relevant classes dealing with storage.
+
+![DataStoringUML](./diagrams/src/DataStoring/DateStoring.png)


Same issue here, would removing the green 'C' be better?

NicholasTanYY · 2024-04-03T05:47:08Z

+   Expected: `view joe` now shows the Student details of a student with Name: joe, Phone Number: 11111111. Other fields that were left blank will reflect 'Unknown' or for date fields, today's date.
+   3. Test case: `add` and when prompted for Name, `joe`. `11111111` when prompted for phone number, press enter to skip other fields.
+   <br />
+   Expected: `view joe` shows the same results as when a student was added via `add joe`.


Adding a
tag here might help with the indentation issue!

NicholasTanYY · 2024-04-03T05:49:41Z

+### Viewing a student's details
+1. View a student who has been added to the student list
+   1. Prerequisites: Add one student named 'joe' to the list with the `add` command
+   2. Test case: `view joe`
+   <br />
+   Expected: Student's details shown correspond to the details input when `add` was used to add a student.
+   3. Test case: `view dogman`
+   <br />
+   Expected: No details are displayed, an error message stating 'Student not found!' is shown.


Perhaps this section can be supported with code blocks showing the expected outputs that corresponds to the inputs given instead to make things clearer?

PureUsagi

Overall great work on the develop guide, but there may some errors with the sequence diagrams.

PureUsagi · 2024-04-04T01:14:05Z

+
+- [Source](https://se-education.org/addressbook-level3/DeveloperGuide.html#proposed-undoredo-feature)
+- Used as template to structure this Developer Guide



Shouldn't there be a table of contents to give readers easy access to various parts of the developer guide? Maybe putting one can help with the navigability of the guide!

I agree, a table of contents should be added.

PureUsagi · 2024-04-04T01:30:27Z

+
+#### Implementation and rationale
+
+![InputParsingSequenceDigram](./diagrams/src/InputParsing/InputParsingSequenceDiagram.png)


I think the stickman and database image are unnecessary for the sequence diagram. Actually, shouldn't the database image be omitted as its irrelevant to the course?

PureUsagi · 2024-04-04T01:36:01Z

@@ -35,4 +213,21 @@

 ## Instructions for manual testing


Maybe the manual testing section can have more commands to be more comprehensive (e.g delete, list, or edit)? Rather than testing each command in isolation, maybe can group them together for a single test(e.g show add first, then list, then delete, then list, etc......)?

PureUsagi · 2024-04-04T01:43:21Z

+
+Please see the diagram below to see how identifying a student works.
+
+![studentIdentification](./diagrams/src/DataStoring/Student%20Identification.png)


Shouldn't the entity names be strictly classes? Having the names as methods like findStudentByName and findStudentByNumber might not follow the sequence diagram standard.

PureUsagi

One more extra comment on one of the diagrams

PureUsagi · 2024-04-04T02:00:58Z

+The `StudentSorter` class facilitates sorting of the list of students based on various criterion.
+As of the latest iteration, it sorts the master list of students in the order specified by the user.
+
+![StudentSorterUML](./diagrams/src/StudentSorter/StudentSorter.png) 


Similar to other diagrams in the develop guide, shouldn't the PlantUML notations / formatting be disabled (e.g. access modifier, green 'C')?

damiwee

Overall, seems like you guys are on the right path, just need to fill in the missing components and some tiny errors in the diagrams.

damiwee · 2024-04-04T03:12:43Z

+
+- [Source](https://se-education.org/addressbook-level3/DeveloperGuide.html#proposed-undoredo-feature)
+- Used as template to structure this Developer Guide



I agree, a table of contents should be added.

damiwee · 2024-04-04T03:14:43Z

+
+This component ensures that the user parses in commands in a format that makes sense, which will modify the master list.
+
+![InputParsingUML](./diagrams/src/InputParsing/InputParsing.png)


Yes, you can refer to the plant UML documentation to remove the circles.

damiwee · 2024-04-04T03:15:37Z

+#### Design considerations
+- The parser must be effecive in breaking down the user's input into its constitutent commands, with further breakdown if an associated argument is added.
+- The parser should be quick and effective in understanding the user's input, with simple prompts given to help the user in correctly parsing the command through the input parser.
+- Allowing the user to input optional arguments. For example, the user could type `view <student name>`, which takes in the "student name" as an optional argument. This is to increase the robustness of the program, which accounts for the two types of users, one who just types in `view`, and the other as formerly mentioned above. 
+- Error handling must be intuitive for the user, so that appropriate error messages are produced if the user does not input a valid command. The error handling should also be robust, to account for the event a user is incapable in following instructions.


Perhaps consider splitting into user and developer design considerations

damiwee · 2024-04-04T03:16:42Z

+
+#### Implementation and rationale
+
+![InputParsingSequenceDigram](./diagrams/src/InputParsing/InputParsingSequenceDiagram.png)


User does not need a ":"

damiwee · 2024-04-04T03:31:46Z

-{Describe the value proposition: what problem does it solve?}
+Classify serves as an attempt to modernise administrative tasks in education institutes, such as tuition centres or school environments.

 ## User Stories


User stories seems incomplete

HiteshriAcharya · 2024-04-04T04:28:21Z

+
+This component ensures that the user parses in commands in a format that makes sense, which will modify the master list.
+
+![InputParsingUML](./diagrams/src/InputParsing/InputParsing.png)


Please disable the symbols "C"

HiteshriAcharya · 2024-04-04T04:29:47Z

+
+This component ensures that the user parses in commands in a format that makes sense, which will modify the master list.
+
+![InputParsingUML](./diagrams/src/InputParsing/InputParsing.png)


Wow, you are using a package diagram! Maybe, the use of a Package Diagram might be confusing?

HiteshriAcharya · 2024-04-04T04:36:07Z

+
+#### Implementation and rationale
+
+![InputParsingSequenceDigram](./diagrams/src/InputParsing/InputParsingSequenceDiagram.png)


I think the activation bar is incomplete

HiteshriAcharya · 2024-04-04T04:48:28Z

+
+#### Implementation and rationale
+
+![InputParsingSequenceDigram](./diagrams/src/InputParsing/InputParsingSequenceDiagram.png)


Please follow the format of the sequence diagram hehe and maybe the images in the middle might not be needed?

…udentList and SubjectLists

…into ParseTextFile

Update functionality for the process command

…into Bug_Fixing

Bug fixing

… other methods. Add option for user to delete file in cases where they are unable to manually rectify corruption by editing the info file(that they messed up)

Add handling for cases of file corruption that are not handled by our…

Add archive component to Dg

Fix typos in DG

…into V2.1

UG Finale

Update PPP

Update DeveloperGuide.md

…into V2.1 # Conflicts: # docs/DeveloperGuide.md

Update DG

Add User Story

…into bugfixv2.0

Bugfixv2.0

yeozongyao added a commit to yeozongyao/tp that referenced this pull request Mar 28, 2024

Merge pull request nus-cs2113-AY2324S2#37 from yeozongyao/branch-zong…

2414f3a

…yao-defensiveCoding Branch zongyao defensive coding

Mmaxx15 reviewed Apr 3, 2024

View reviewed changes

NicholasTanYY reviewed Apr 3, 2024

View reviewed changes

PureUsagi reviewed Apr 4, 2024

View reviewed changes

damiwee reviewed Apr 4, 2024

View reviewed changes

HiteshriAcharya reviewed Apr 4, 2024

View reviewed changes

blackmirag3 and others added 23 commits April 11, 2024 21:50

Update UG

1d8620f

Fix formatting for UG

d27c5f4

Update expected test case output

e625df3

Make private class public for usage in other parts of codebaase

5006917

Update process command workflow to reduce double counting in MasterSt…

6e81f63

…udentList and SubjectLists

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

1d6ac25

…into ParseTextFile

Merge pull request #266 from ParthGandhiNUS/ParseTextFile

b54efb3

Update functionality for the process command

Fix bug for the max number of classes attended

b4e1a28

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

5cfc987

…into Bug_Fixing

Fix small bug

fafd7f3

Merge pull request #267 from ParthGandhiNUS/Bug_Fixing

06f44f9

Bug fixing

Add handling for cases of file corruption that are not handled by our…

672f2f1

… other methods. Add option for user to delete file in cases where they are unable to manually rectify corruption by editing the info file(that they messed up)

Fix wrong indentation for comment

9ccd417

Fix incorrect indentation

7271f8f

Merge pull request #268 from alalal47/corruption_handling

917ced5

Add handling for cases of file corruption that are not handled by our…

Update README file to match our product

193c7bf

Update PPP

b4e5259

Update Junit tests

fc97952

Delete unused package

ca903f9

Remove unneccessary test class, update inputparsingtest

46eac07

Update StudentAttributesTest

980a777

Update PPP

3aceab6

Remove extraneous bracket

40fb493

alalal47 and others added 30 commits April 15, 2024 21:14

Merge pull request #313 from blackmirag3/shui-edit-v2

3b0ce95

Add archive component to Dg

Fix typos in DG

4cf5cee

Merge pull request #314 from alalal47/help_revamp

4f13320

Fix typos in DG

UG is frustrating

a1fe572

UG is not stonks

a480fbf

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

8861807

…into V2.1

Merge pull request #315 from ParthGandhiNUS/V2.1

73219a0

UG Finale

Update PPP

7de0bd5

Merge pull request #316 from ParthGandhiNUS/V2.1

4db4c93

Update PPP

Update DeveloperGuide.md

4a9927c

Update DeveloperGuide.md

e163cc5

Merge pull request #317 from AY2324S2-CS2113-T13-3/Cryolian-patch-2

12d6925

Update DeveloperGuide.md

Update DG

b797228

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

03d3c04

…into V2.1 # Conflicts: # docs/DeveloperGuide.md

Update DG

ec14ffe

Update DG

45613aa

Update DG

498f275

Update DG

be125fe

Merge pull request #318 from ParthGandhiNUS/master

8314fa7

Update DG

test fix

b18b319

Add User Story

2c3321a

Merge pull request #319 from ParthGandhiNUS/master

746b448

Add User Story

fix apos

1e07c96

typo

991db77

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

85b6fc7

…into bugfixv2.0

change back to 6

2f9832d

change enter

e2a3392

change back

99eed62

Merge pull request #320 from Cryolian/bugfixv2.0

307d1fc

Bugfixv2.0

Update DeveloperGuide.md

c0b6de8


		#### Implementation and rationale

		![InputParsingSequenceDigram](./diagrams/src/InputParsing/InputParsingSequenceDiagram.png)


		Seen below is an UML diagram of the relevant classes dealing with storage.

		![DataStoringUML](./diagrams/src/DataStoring/DateStoring.png)


		This component ensures that the user parses in commands in a format that makes sense, which will modify the master list.

		![InputParsingUML](./diagrams/src/InputParsing/InputParsing.png)


		Please see the diagram below to see how identifying a student works.

		![studentIdentification](./diagrams/src/DataStoring/Student%20Identification.png)


		- [Source](https://se-education.org/addressbook-level3/DeveloperGuide.html#proposed-undoredo-feature)
		- Used as template to structure this Developer Guide

Uh oh!

Conversation

ParthGandhiNUS commented Mar 7, 2024

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!

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

PureUsagi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

damiwee Apr 4, 2024 • 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!

PureUsagi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

damiwee left a comment

Choose a reason for hiding this comment

Uh oh!

damiwee Apr 4, 2024 • 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!

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

damiwee Apr 4, 2024 •

edited

Loading

damiwee Apr 4, 2024 •

edited

Loading