Skip to content

Commit

Permalink
Merge d4f6775 into db5b14f
Browse files Browse the repository at this point in the history
  • Loading branch information
zhicaizack committed Nov 12, 2018
2 parents db5b14f + d4f6775 commit 22de599
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 19 deletions.
36 changes: 18 additions & 18 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2117,7 +2117,6 @@ Steps 1a1-1a2 are repeated until the data entered is correct.
Use case resumes from step 1.
// end::gradeusecase[]

// tag::classmanagementdepth[]
[discrete]
=== Use case: Add Class

Expand Down Expand Up @@ -2234,6 +2233,7 @@ Use case resumes at step 1.
+
Use case resumes at step 1.

// tag::classmanagementdepth[]
[discrete]
=== Use case: Assign Student To Class

Expand Down Expand Up @@ -2795,11 +2795,11 @@ mc/MODULE_CODE, +
e/MAX_ENROLLMENT

.. Prerequisites: Module code must exist before creating a class for the module.
.. Test case: `class add cn/T16 mc/CG1111 e/20` +
Expected: A new class T16 of module code CG1111 and enrollment size of 20 will be created and reflected in the system.
.. Test case: `class add cn/T16 mc/CG1111 e/9999` +
.. Test case: `class add cn/T16 mc/CS2113 e/20` +
Expected: A new class T16 of module code CS2113 and enrollment size of 20 will be created and reflected in the system.
.. Test case: `class add cn/T16 mc/CS2113 e/9999` +
Expected: A message will be displayed to show that enrollment size should be of 1-425 and it should not be blank.
.. Test case: `class add cn/T1600 mc/CG1111 e/20` +
.. Test case: `class add cn/T1600 mc/CS2113 e/20` +
Expected: A message will be displayed to show that class name should only contain between 1 to 3 alphanumeric characters and it should not be blank.
.. Other incorrect class add commands to try: `class add`, +
`class add cn/T16 mc/XXYYYY e/20` (where XXYYYY is a valid module code that does not exist), +
Expand All @@ -2826,9 +2826,9 @@ mc/MODULE_CODE, +
e/ENROLLMENT_SIZE

.. Prerequisites: Module code must exist before deleting a class for the module. The classroom must also belong to the module code.
.. Test case: `class edit cn/T16 mc/CG1111 e/69` +
Expected: The max enrollment size of class T16 of module code CG1111 will be updated to 69 and reflected in the system.
.. Test case: `class edit cn/T16 mc/CG1111 e/9999` +
.. Test case: `class edit cn/T16 mc/CS2113 e/69` +
Expected: The max enrollment size of class T16 of module code CS2113 will be updated to 69 and reflected in the system.
.. Test case: `class edit cn/T16 mc/CS2113 e/9999` +
Expected: A message will be displayed to show that enrollment size should be of 1-425 and it should not be blank.
.. Other incorrect class edit commands to try: `class edit`, +
`class edit cn/T16 mc/XXYYYY e/20` (where XXYYYY is a valid module code that does not exist), +
Expand All @@ -2845,8 +2845,8 @@ cn/CLASS_NAME, +
mc/MODULE_CODE

.. Prerequisites: Module code must exist before deleting a class for the module. The classroom must also belong to the module code.
.. Test case: `class delete cn/T16 mc/CG1111` +
Expected: The class T16 of module code CG1111 deleted and reflected in the system.
.. Test case: `class delete cn/T16 mc/CS2113` +
Expected: The class T16 of module code CS2113 deleted and reflected in the system.
.. Other incorrect class delete commands to try: `class delete`, +
`class delete cn/VVV mc/XXYYYY` (where VVV is a valid class name not belonging to a valid module XXYYYY) +
Expected: A message will be displayed to show `Invalid command format!`, +
Expand All @@ -2861,8 +2861,8 @@ mc/MODULE_CODE, +
i/MATRIC_NO

.. Prerequisites: Student must exist in the system, module code must exist, student must be enrolled in the module, class cannot be full and class must exist and belong to the module code before assigning a student to the class.
.. Test case: `class addstudent cn/T16 mc/CS2113 i/A0168000B` +
Expected: A new student of matric number A0168000B will be assigned to the classroom T16 of module CS2113 and be reflected in the system.
.. Test case: `class addstudent cn/T16 mc/CS2113 i/A0168372L` +
Expected: A new student of matric number A0168372L will be assigned to the classroom T16 of module CS2113 and be reflected in the system.
.. Other incorrect class addstudent commands to try: `class addstudent`, +
`class addstudent cn/VVV mc/ZZZZZZ i/XXXXXXXXX` (where XXXXXXXXX is a valid matric number that does not exist, VVV and ZZZZZZ is a valid existing class), +
`class addstudent cn/VVV mc/ZZZZZZ i/XXXXXXXXX` (where XXXXXXXXX is an existing student matric number enrolled into ZZZZZZ, VVV is a valid class name format but do not belong to an existing module ZZZZZZ), +
Expand All @@ -2883,8 +2883,8 @@ i/MATRIC_NO

.. Prerequisites: Student must exist in the system, module code must exist, student must be enrolled in the module, class must exist and belong to the module code
and student must be assigned to the class before unassigning a student from the class.
.. Test case: `class delstudent cn/T16 mc/CS2113 i/A0168000B` +
Expected: The student of matric number A0168000B will be unassigned from the classroom T16 of module CS2113 and be reflected in the system.
.. Test case: `class delstudent cn/T16 mc/CS2113 i/A0168372L` +
Expected: The student of matric number A0168372L will be unassigned from the classroom T16 of module CS2113 and be reflected in the system.
.. Other incorrect class delstudent commands to try: `class delstudent`, +
`class delstudent cn/VVV mc/ZZZZZZ i/XXXXXXXXX` (where XXXXXXXXX is a valid matric number format that does not exist, VVV and ZZZZZZ is a valid existing class), +
`class delstudent cn/VVV mc/ZZZZZZ i/XXXXXXXXX` (where XXXXXXXXX is an existing student matric number enrolled into ZZZZZZ, VVV is a valid class name not belonging to an existing module ZZZZZZ), +
Expand All @@ -2904,8 +2904,8 @@ mc/MODULE_CODE, +
i/MATRIC_NO

.. Prerequisites: Student must exist in the system, module code must exist, class must exist and belong to the module code, student must belong to class before marking the student present for the class.
.. Test case: `class markattendance cn/T16 mc/CS2113 i/A0168000B` +
Expected: The student of matric number A0168000B from the classroom T16 of module CS2113 will be marked present and be reflected in the system.
.. Test case: `class markattendance cn/T16 mc/CS2113 i/A0168372L` +
Expected: The student of matric number A0168372L from the classroom T16 of module CS2113 will be marked present and be reflected in the system.
.. Other incorrect class markattendance commands to try: `class markattendance`, +
`class markattendance cn/VVV mc/ZZZZZZ i/XXXXXXXXX` (where XXXXXXXXX is a valid matric number format but does not exist, VVV and ZZZZZZ is a valid existing class), +
`class markattendance cn/VVV mc/ZZZZZZ i/XXXXXXXXX` (where XXXXXXXXX is an existing student matric number enrolled into ZZZZZZ, VVV is a valid class name not belonging to an existing module ZZZZZZ), +
Expand Down Expand Up @@ -2942,8 +2942,8 @@ mc/MODULE_CODE, +
i/MATRIC_NO

.. Prerequisites: Module must exist, class must exist and belong to the module code, student must exist and belong to the class and marked present before being able to modify their attendance to absent.
.. Test case: `class modattendance cn/T16 mc/CS2113 i/A0168000B` +
Expected: The student of matric number A0168000B from the classroom T16 of module CS2113 will be marked absent and be reflected in the system.
.. Test case: `class modattendance cn/T16 mc/CS2113 i/A0168372L` +
Expected: The student of matric number A0168372L from the classroom T16 of module CS2113 will be marked absent and be reflected in the system.
.. Other incorrect class modattendance commands to try: `class modattendance`, +
`class modattendance cn/VVV mc/ZZZZZZ i/XXXXXXXXX` (where XXXXXXXXX is a valid matric number that does not exist, VVV and ZZZZZZ is a valid existing class), +
`class modattendance cn/VVV mc/ZZZZZZ i/XXXXXXXXX` (where XXXXXXXXX is an existing student matric number enrolled into ZZZZZZ, VVV is a valid class name not belonging to an existing module ZZZZZZ), +
Expand Down
2 changes: 1 addition & 1 deletion docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,6 @@ Assigns the student with matric no. `A0171234B` as a TA.
* `module assign mc/CS2113 e/e0191234@u.nus.edu` +
Assigns the student with email `e0191234@u.nus.edu` as a TA.

// tag::classmanagementdepth[]
=== Class Management
==== Add Class : `class add`
Creates a class and assigns it to a module for the system. +
Expand Down Expand Up @@ -345,6 +344,7 @@ Deletes the class T16 from the module CG1111
* `class edit cn/T16 mc/CG1111 e/69` +
Modifies the new max class enrollment size for the class T16 of module CG1111 to be 69

// tag::classmanagementdepth[]
==== Assign Student To Class : `class addstudent`
Assigns a student to a class in the system. +
Format: `class addstudent cn/CLASS_NAME mc/MODULE_CODE i/MATRIC_NO`
Expand Down
2 changes: 2 additions & 0 deletions docs/team/zhicaizack.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Trajectory is a lightweight management system for those who need a no-frills sol

** Project management:
*** Friendly reminder for team to update documentation for `v1.2` on GitHub
*** Fix checkstyle issues on a global scale
*** Updated the diagram for UI segment in developer guide
** Community:
*** Contributed to issue discussions (examples: https://github.com/CS2113-AY1819S1-T16-1/main/issues/280#issuecomment-435569592)
*** Reported bugs and suggestions for other teams in the class (examples: https://github.com/CS2113-AY1819S1-W13-4/main)
Expand Down

0 comments on commit 22de599

Please sign in to comment.