Skip to content

Commit

Permalink
Merge pull request #220 from nigelnnk/master
Browse files Browse the repository at this point in the history
Edit documentation to include names
  • Loading branch information
CranstonYeo committed Apr 12, 2020
2 parents 3ecf391 + 04d8ff0 commit c4ca24d
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 14 deletions.
10 changes: 5 additions & 5 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Classes used by multiple components are in the `seedu.address.commons` package.
This section describes some noteworthy details on how certain features are implemented.

// tag::module[]
=== Module feature
=== Module feature (Written by Nigel Neo)
*TAble* allows NUS SoC teaching assistants to track and record all modules that they are teaching. Users can leave notes on the modules that they are teaching and store a list of links for the module that are useful for reference.

==== Implementation
Expand Down Expand Up @@ -213,7 +213,7 @@ Reason for choosing Alternative 1: On a user design perspective, it is less jarr

// tag::tutorial[]

=== Tutorial feature
=== Tutorial feature (Written by Sarah Lim)
*TAble* allows NUS teaching assistants to track and record all the tutorials they are teaching, and maintain details of the tutorial, such as the module it is under, start and end time of the tutorial, and the location it is held.
Tutorials in *TAble* also allow teaching assistants to enroll students in a tutorial and mark their attendance for every week of the semester, and allows for convenient referencing (particularly when there's a pandemic and contact tracing is critical).

Expand Down Expand Up @@ -265,7 +265,7 @@ If successful, the updated information is then saved.
// end::tutorial[]

// tag::consult[]
=== Consult feature
=== Consult feature (Written by Han Ching)
*TAble* allows NUS SoC teaching assistants to track and record all their consultations scheduled with their students.

==== Implementation
Expand Down Expand Up @@ -333,7 +333,7 @@ Reason for choosing Alternative 1: We believe that automatically sorting the co
// end::consult[]

// tag::reminder[]
=== Reminder feature
=== Reminder feature (Written by Cranston Yeo)
*TAble* allows NUS SoC teaching assistants to create reminders to help them in keeping track of their ongoing or upcoming tasks.

==== Implementation
Expand Down Expand Up @@ -394,7 +394,7 @@ Furthermore, they are hard to test due to their volatile nature and including th
// end::reminder[]

// tag::calendar[]
=== Calendar feature
=== Calendar feature (Written by Han Ching)
*TAble* allows NUS SoC teaching assistants to bring up a calendar view of all their upcoming consults, tutorials and reminders.

==== Implementation
Expand Down
16 changes: 8 additions & 8 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Format: `help`

* A window containing the link to our User Guide will appear. Click on the Copy Link button to copy the link to our User Guide.

=== Students Feature
=== Students Feature (Written by Shun De)
==== Adding a student: `addStudent`

Adds a student to TAble +
Expand Down Expand Up @@ -214,7 +214,7 @@ Deletes the 1st student in the results of the `find` command.
// end::delete[]

//tag::Module[]
=== Module Feature
=== Module Feature (Written by Nigel Neo)
==== Add Module into database: `addMod`
Adds a module into TAble.

Expand Down Expand Up @@ -320,7 +320,7 @@ Format: `viewModInfo modCode/MODULE_CODE`
****

==== Add lecture timeslot: `addModLecture` [coming in v2.0]
Adds lecture timeslot to module. This is to be included to integrate with the consultation finding feature. +
Adds lecture timeslot to module. This is to be integrated with the future calendar display feature. +
Format: `addModLecture modCode/MODULE_CODE d/DAY from/TIME to/TIME p/LOCATION`

Example:
Expand All @@ -338,7 +338,7 @@ Example:
//end::Module[]

// tag::Tutorial[]
=== Tutorials Feature
=== Tutorials Feature (Written by Sarah Lim)

==== Switch GUI Display to Tutorial List View: `listTutorial`

Expand Down Expand Up @@ -518,7 +518,7 @@ Example:
//end::Tutorial[]

//tag::ExportTutorialAttendance[]
==== Export tutorial attendance to csv file: `exportAttendance`
==== Export tutorial attendance to csv file: `exportAttendance` (Written by Nigel Neo)

Exports the attendance data of all enrolled students in a tutorial group to a csv file, where the filepath is specified by the user.
Format: `exportAttendance tutorialIndex/INDEX csvFilePath/FILEPATH`
Expand All @@ -538,7 +538,7 @@ Example:
//end::ExportTutorialAttendance[]

// tag::Consult[]
=== Consults Feature
=== Consults Feature (Written by Han Ching)
[NOTE]
The consults that are overdue will appear in red to highlight that these consults are ready to be deleted!

Expand Down Expand Up @@ -631,7 +631,7 @@ Returns any consults that are held at SR3


// tag::Reminder[]
=== Reminder Feature
=== Reminder Feature (Written by Cranston Yeo)
==== Adding a reminder: `addReminder`

Adds a reminder to the reminder list. +
Expand Down Expand Up @@ -750,7 +750,7 @@ Returns all reminders on 05 May 2020.
//end::Reminder[]

// tag::Calendar[]
=== Calendar Feature
=== Calendar Feature (Written by Han Ching)
==== Display the calendar window: `viewCalendar`

Brings up the calendar window.
Expand Down
5 changes: 5 additions & 0 deletions docs/team/nigelnnk.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,11 @@ TAble is your handy desktop app, optimized for TAs who prefer to work with a Com

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

'''

=== Tutorial Feature
include::../UserGuide.adoc[tag=ExportTutorialAttendance]

== Contributions to the Developer Guide

|===
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ public CommandResult execute(Model model) throws CommandException {
for (int i = 0; i < consultsToBeDeleted.size(); i++) {
model.deleteConsult(consultsToBeDeleted.get(i));
}
return new CommandResult(String.format(MESSAGE_DELETE_STUDENT_SUCCESS, studentToDelete));
return new CommandResult(String.format(MESSAGE_DELETE_STUDENT_SUCCESS, studentToDelete),
false, false, false, true, false);
}

@Override
Expand Down

0 comments on commit c4ca24d

Please sign in to comment.