Skip to content

Commit 55fbb35

Browse files
committed
Sadd visual (#244)
* Update javadocs, consistency on sessions to use small s * Add picture for sadd
1 parent 57cc47c commit 55fbb35

7 files changed

Lines changed: 74 additions & 17 deletions

File tree

docs/UserGuide.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -502,8 +502,16 @@ This helps to prevent you from accidentally agreeing to 2 sessions that overlaps
502502

503503
</div>
504504

505+
<figure style="width:auto; text-align:center; padding:0.5em; font-style: italic; font-size: smaller;">
506+
<p>
507+
<img src="images/sadd_sample.png" style="width: 100%; height: auto;"/>
508+
</p>
509+
<figcaption>Figure - Result of executing <code>sadd g/New Gym ex/Endurance at/06/11/2020 0900 t/65</code></figcaption>
510+
</figure>
511+
505512
Examples:
506-
* `sadd g/Machoman Gym ex/Endurance at/29/09/2020 1600 t/120` adds a session at gym `Machoman` with exercise type `Endurance` at `29/09/2020 1600hrs` that lasts for `120` minutes
513+
* `sadd g/New Gym ex/Endurance at/06/11/2020 0900 t/65` adds a session at gym `New Gym` with exercise type `Endurance` at `06/11/2020 0900hrs` that lasts for `65` minutes.
514+
If the session is within the [viewing period](#334-viewing-sessions-within-period-sview) of the Session List, it will be displayed on the right panel of the UI.
507515

508516

509517
### 3.3.2 Editing a Session : `sedit`

docs/images/sadd_sample.png

75.3 KB
Loading

docs/team/benclmnt.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
layout: page
3+
title: Bennett Clement's Project Portfolio Page
4+
---
5+
6+
## Project: FitEgo
7+
8+
FitEgo is a desktop application for fitness instructors to schedule, and keep track of his/her customers' progress in one place.
9+
10+
Given below are my contributions to the project.
11+
12+
* **New Feature**: Added the ability to add / delete sessions.
13+
* What it does: allows the user to create and delete fitness sessions
14+
* Justification: This feature is core to the product because the user needs to create a session before they can schedule a client.
15+
* Highlights: This enhancement required an in-depth analysis of design alternatives.
16+
The implementation was challenging as it deals with dates, the notion of "overlapping" dates, and handling schedules related to the session
17+
18+
* **New Feature**: Added table to view a list of client's schedules
19+
* What it does: List client's schedules (with remarks, payment status and exercise type)
20+
* Justification: This feature makes it easy for the user to keep track of client's progress in one page
21+
* Highlights: The implementation was challenging as it required the table to be resizable and to show updates as soon as user changes any details about the client / schedules.
22+
23+
* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2021s1.github.io/tp-dashboard/#breakdown=true&search=&sort=groupTitle&sortWithin=title&since=2020-08-14&timeframe=commit&mergegroup=&groupSelect=groupByRepos&checkedFileTypes=docs~functional-code~test-code~other&tabOpen=true&tabType=authorship&tabAuthor=benclmnt&tabRepo=AY2021S1-CS2103T-T13-3%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=test-code)
24+
25+
* **Project management**:
26+
* Managed all releases `v1.1` - `v1.3` (4 releases) on GitHub
27+
* Setting up the GitHub team org/repo
28+
* Setting up tools (Gradle)
29+
* Maintained issue tracker by setting up milestones, label and triaging bugs
30+
31+
* **Enhancements to existing features**:
32+
* Wrote tests for Session model (Pull requests [\#140](https://github.com/AY2021S1-CS2103T-T13-3/tp/pull/140))
33+
34+
* **Documentation**:
35+
* User Guide:
36+
* Added documentation for the features `sadd` and `sdel` [\#139](https://github.com/AY2021S1-CS2103T-T13-3/tp/pull/139)
37+
* Added explanation on common terminologies used in FitEgo User Guide [\#139](https://github.com/AY2021S1-CS2103T-T13-3/tp/pull/139)
38+
* Developer Guide:
39+
* Added implementation details of the `sdel` feature.
40+
41+
* **Review/mentoring contributions**:
42+
* Regularly discuss implementation details in our group's communication channel.
43+
* Help others debug and find solution during team meetings.
44+
* Post issues and discussions on issue tracker. (Some examples:
45+
[\#98](https://github.com/AY2021S1-CS2103T-T13-3/tp/issues/98), [\#107](https://github.com/AY2021S1-CS2103T-T13-3/tp/issues/107), [\#223](https://github.com/AY2021S1-CS2103T-T13-3/tp/issues/223))
46+
47+
* **Tools**:
48+
* Integrated a new Github plugin (PlantUML) to the team repo
49+

src/main/java/seedu/address/commons/core/Messages.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ public class Messages {
77

88
public static final String MESSAGE_UNKNOWN_COMMAND = "Unknown command";
99
public static final String MESSAGE_INVALID_COMMAND_FORMAT = "Invalid command format! \n%1$s";
10-
public static final String MESSAGE_INVALID_CLIENT_DISPLAYED_INDEX = "The Client index provided is invalid";
11-
public static final String MESSAGE_INVALID_SESSION_DISPLAYED_INDEX = "The Session index provided is invalid";
12-
public static final String MESSAGE_INVALID_SCHEDULE_DISPLAYED_INDEX = "The Schedule index provided is invalid";
13-
public static final String MESSAGE_CLIENTS_LISTED_OVERVIEW = "%1$d Clients listed!";
10+
public static final String MESSAGE_INVALID_CLIENT_DISPLAYED_INDEX = "The client index provided is invalid";
11+
public static final String MESSAGE_INVALID_SESSION_DISPLAYED_INDEX = "The session index provided is invalid";
12+
public static final String MESSAGE_INVALID_SCHEDULE_DISPLAYED_INDEX = "The schedule index provided is invalid";
13+
public static final String MESSAGE_CLIENTS_LISTED_OVERVIEW = "%1$d clients listed!";
1414

1515
}

src/main/java/seedu/address/logic/commands/session/AddSessionCommand.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
public class AddSessionCommand extends Command {
1919
public static final String COMMAND_WORD = "sadd";
2020

21-
public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a Session to FitEgo. "
21+
public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a session to FitEgo. "
2222
+ "Parameters: "
2323
+ PREFIX_GYM + "GYM "
2424
+ PREFIX_EXERCISE_TYPE + "EXERCISE_TYPE "
@@ -30,9 +30,9 @@ public class AddSessionCommand extends Command {
3030
+ PREFIX_START_TIME + "29/09/2020 1600 "
3131
+ PREFIX_DURATION + "120 ";
3232

33-
public static final String MESSAGE_SUCCESS = "New Session added: %1$s";
34-
public static final String MESSAGE_DUPLICATE_SESSION = "This Session overlaps with an existing Session in FitEgo.\n"
35-
+ "A Session is considered overlapping if another Session starts before the current Session ends.";
33+
public static final String MESSAGE_SUCCESS = "New session added: %1$s";
34+
public static final String MESSAGE_DUPLICATE_SESSION = "This session overlaps with an existing session in FitEgo.\n"
35+
+ "A session is considered overlapping if it starts before the previous session ends.";
3636

3737
private final Session toAdd;
3838

src/main/java/seedu/address/logic/commands/session/DeleteSessionCommand.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ public class DeleteSessionCommand extends Command {
2020
public static final String COMMAND_WORD = "sdel";
2121

2222
public static final String MESSAGE_USAGE = COMMAND_WORD
23-
+ ": Deletes the Session identified by the index number used in the displayed Session list.\n"
23+
+ ": Deletes the session identified by the index number used in the displayed Session List.\n"
2424
+ "Parameters: INDEX (must be a positive integer)\n"
2525
+ "Example: " + COMMAND_WORD + " 1";
2626

27-
public static final String MESSAGE_DELETE_SESSION_SUCCESS = "Deleted Session: %1$s";
27+
public static final String MESSAGE_DELETE_SESSION_SUCCESS = "Deleted session: %1$s";
2828

2929
public static final String MESSAGE_FORCE_DELETE_SESSION_USAGE = COMMAND_WORD
30-
+ ": Cannot delete the Session identified by the index number because there are schedules associated to it."
30+
+ ": Cannot delete the session identified by the index number because there are schedules associated to it."
3131
+ "\nTo force delete, pass in f/ as an option. BEWARE, YOU WILL LOSE ALL RELATED SCHEDULES."
3232
+ "\nParameters: INDEX (must be a positive integer) f/"
3333
+ "\nExample: " + COMMAND_WORD + " 1 f/";

src/main/java/seedu/address/logic/commands/session/EditSessionCommand.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ public class EditSessionCommand extends Command {
2525

2626
public static final String COMMAND_WORD = "sedit";
2727

28-
public static final String MESSAGE_USAGE = COMMAND_WORD + ": Edits the details of the Session identified "
29-
+ "by the index number used in the displayed Session list.\n"
28+
public static final String MESSAGE_USAGE = COMMAND_WORD + ": Edits the details of the session identified "
29+
+ "by the index number used in the displayed Session List.\n"
3030
+ "Existing values will be overwritten by the input values.\n"
3131
+ "Parameters: INDEX (must be a positive integer) "
3232
+ "[" + PREFIX_GYM + "GYM] "
@@ -38,10 +38,10 @@ public class EditSessionCommand extends Command {
3838
+ PREFIX_START_TIME + "29/09/2020 1600 "
3939
+ PREFIX_DURATION + "120 ";
4040

41-
public static final String MESSAGE_EDIT_SESSION_SUCCESS = "Edited Session: %1$s";
41+
public static final String MESSAGE_EDIT_SESSION_SUCCESS = "Edited session: %1$s";
4242
public static final String MESSAGE_NOT_EDITED = "At least one field to edit must be provided.";
43-
public static final String MESSAGE_DUPLICATE_SESSION = "This Session already exists in FitEgo.";
44-
public static final String MESSAGE_OVERLAPPING_SESSION = "This Session overlaps with another "
43+
public static final String MESSAGE_DUPLICATE_SESSION = "This session already exists in FitEgo.";
44+
public static final String MESSAGE_OVERLAPPING_SESSION = "This session overlaps with another "
4545
+ "session in the FitEgo.";
4646

4747
private final Index index;

0 commit comments

Comments
 (0)