Skip to content

Commit

Permalink
Updated docs (#214)
Browse files Browse the repository at this point in the history
* Fixed Tutorial.setStudent() and EditCommandTest

* Update user guide

* Updated user guide

* Fixed setStudent() and EditCommand yet again

* Fixed bugs
fixed: included prefix mat_no and nusid in argmultimap for addstudentcommandparser
fixed: added issameperson() in Student which is called in contains in UniquePersonList which is called in addstudent/hasstudent in application, changed message_duplicate_student to reflect the new logic
changed: error messages (invalid ... in ...) to for better comprehension
changed: command usage messages for better comprehension
fixed: included conditional in application.setstudent() that does nothing if editedstudent and target are equal to avoid bug where student reference is changed in uniquepersonlist when the same student is added and removed
fixed: partialinputparsertest where by bob and amy had the same nusnetid and matricnums

* More bug fixes
fixed: changed assignment/tutname/eventname regex
fixed: display not a valid command, removed from Finder.java
fixed: optional[] no longer printed for optional fields in student.toString()
fixed: duplicateevents error not shown in console for addEventCommand

* Bug fixes:
fixed: import command whereby no error is shown in console when import https://nusmods.com/timetable/sem-1/share? is inputted
changed: import command message
changed: tutname regex to accept non white space characters

* Fixed listEvents bug
changed: displayassignmentscommand message usage - please update user guide
changed: studentnotfoundexception message in setassignmentscorecommand
fixed: did not throw error when setscore command is called for a student not in the tutorial

* Updated docs

* Patched setStudents - clearCommand and undoing deletion of students should work now

* Fixed SetSemStart Storage bug

* Added check to ensure tutorial duration is non-negative
Fixed storage for semStart

* Bug fixes
fixed: Error not thrown in application when application is changed but semstart is null
fixed: Error not thrown when invalid time is inputted for addTutorial (9999)
fixed: SuggestedCommands not set to an empty list when deleteSuggestedCommands is called - causes error to be thrown in terminal
when index is inputted after suggestedCommand.execute() throws an error

* Updated docs

* Updated docs
  • Loading branch information
ZiHawkEye committed Nov 11, 2019
1 parent 430908d commit 90e23e4
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 14 deletions.
20 changes: 18 additions & 2 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,7 @@ Example:
* `cd m`
* `cd s`
// end::FeatureCd[]
// tag::FeatureImport[]
=== Import tutorials via NUSMods url: `import`
Expand All @@ -443,6 +444,7 @@ Example:
Command synonyms: `importtutorials`, `importmods`, `importtutorial`
====
// end::FeatureImport[]
// tag::FeatureMarkAttendance[]
=== Marks attendance of a tutorial `markAttendance`
Expand All @@ -459,13 +461,27 @@ Example:
* markAttendance i/1 w/5
* markAttendance n/John Doe tn/Lab 1 m/CS1010 w/5
Example of marking attendance of student:
Inputting "markAttendance n/Mark tn/Lab Session m/CS1010S w/7" will toggle the attendance of Mark in tutorial of name "Lab Session" and the attendance table of the tutorial will be displayed accordingly.
image::MarkAttendance1.png[width="600"]
image::MarkAttendance2.png[width="600"]
Example of marking attendance of tutorial:
When "markAttendance tn/Lab Session m/CS1010S w/7" is inputted, the application will prompt the user to mark/toggle the attendance of the first student in the tutorial.
image::MarkAttendance3.png[width="600"]
The user may input "y" or "n", after which the command will be executed/cancelled respectively and the application will prompt the user to mark the attendance of the next student.
image::MarkAttendance4.png[width="600"]
[TIP]
====
You can use either tutorial index or tutorial name with module code to specify the tutorial. +
Specifying the student name marks/toggles the attendance of a student, otherwise the entire tutorial will have their attendance marked.
* E.g tn/Lab Session m/CS1010S w/1
Command Synonyms: `mark`, `marka`, `markatt`
====
// end::FeatureMarkAttendance[]
Expand Down
Binary file added docs/images/MarkAttendance1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/MarkAttendance2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/MarkAttendance3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/MarkAttendance4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 0 additions & 12 deletions docs/team/zihawkeye.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -72,20 +72,8 @@ include::../UserGuide.adoc[tag=FeatureMarkAttendance]

include::../UserGuide.adoc[tag=FeatureExportAttendance]

include::../UserGuide.adoc[tag=FeatureAddAssignment]

include::../UserGuide.adoc[tag=FeatureDeleteAssignment]

include::../UserGuide.adoc[tag=FeatureSetAssignmentScore]

include::../UserGuide.adoc[tag=FeatureAddEvent]

include::../UserGuide.adoc[tag=FeatureDeleteEvent]

include::../UserGuide.adoc[tag=FeatureEditEvent]

include::../UserGuide.adoc[tag=FeatureListEvent]

include::../UserGuide.adoc[tag=FeatureSetSemStart]

== Contributions to the Developer Guide
Expand Down

0 comments on commit 90e23e4

Please sign in to comment.