Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links #198

Merged
merged 42 commits into from
Apr 14, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
4c5b129
Merge (#18)
marcus-pzj Mar 19, 2019
58d11e4
Resolve conflicts
marcus-pzj Mar 22, 2019
3ed1b50
Merge (#19)
marcus-pzj Mar 22, 2019
800ea8a
Merge (#21)
marcus-pzj Mar 23, 2019
b718d23
Resolve merge conflicts
marcus-pzj Mar 23, 2019
39d58cb
Merge (#24)
marcus-pzj Mar 23, 2019
4dca755
Merge codacy
marcus-pzj Mar 24, 2019
a2e7955
Resolve conflicts
marcus-pzj Mar 24, 2019
0fb1aa7
resolve whitesapce
marcus-pzj Mar 24, 2019
f4e41a8
Merge (#27)
marcus-pzj Mar 24, 2019
7d1c30e
Testing (#29)
marcus-pzj Mar 25, 2019
2b7d999
Update
marcus-pzj Mar 29, 2019
5834aeb
Merge (#30)
marcus-pzj Mar 29, 2019
024762e
Resolve merge conflict
marcus-pzj Mar 30, 2019
3466536
Merge (#32)
marcus-pzj Mar 30, 2019
5c7b86a
Enhance FindCommand to use Levenshtein Distance (#31)
marcus-pzj Mar 30, 2019
8b97443
Fix codacy issues
marcus-pzj Mar 30, 2019
fa52f01
Merge branch 'master' into master
marcus-pzj Mar 30, 2019
74cdb3e
resolve merge conflict
marcus-pzj Mar 30, 2019
63ceb82
Merge (#33)
marcus-pzj Mar 30, 2019
f1ee71a
Merge (#36)
marcus-pzj Mar 31, 2019
c9e7c8e
Merge branch 'master' of https://github.com/CS2113-AY1819S2-T08-3/main
marcus-pzj Apr 1, 2019
d920c81
Merge branch 'master' of https://github.com/CS2113-AY1819S2-T08-3/main
marcus-pzj Apr 6, 2019
d23eb5b
Fix Bugs in FindCommand and ListCommand
marcus-pzj Apr 7, 2019
3b28834
Fix Checkstyle
marcus-pzj Apr 7, 2019
e69664a
Change ListCommand parser "all"
marcus-pzj Apr 11, 2019
d89626d
Merge branch 'master' of https://github.com/CS2113-AY1819S2-T08-3/main
marcus-pzj Apr 13, 2019
50d8209
Documentation updates
marcus-pzj Apr 13, 2019
d845ad2
Merge branch 'master' of https://github.com/CS2113-AY1819S2-T08-3/mai…
marcus-pzj Apr 13, 2019
7e00c33
Updates to documentation
marcus-pzj Apr 13, 2019
4d23e37
Updates to documentation
marcus-pzj Apr 13, 2019
1d6e695
Updates to documentation
marcus-pzj Apr 13, 2019
a0c814b
Merge branch 'master' of https://github.com/CS2113-AY1819S2-T08-3/mai…
marcus-pzj Apr 13, 2019
d94a7be
Updates to documentation
marcus-pzj Apr 13, 2019
4b79c05
Add images
marcus-pzj Apr 14, 2019
17b3645
Merge branch 'master' of https://github.com/CS2113-AY1819S2-T08-3/mai…
marcus-pzj Apr 14, 2019
aa37aa2
Merge branch 'master' of https://github.com/CS2113-AY1819S2-T08-3/mai…
marcus-pzj Apr 14, 2019
f3bfc69
Documentation Updates
marcus-pzj Apr 14, 2019
b669bee
Merge branch 'master' of https://github.com/CS2113-AY1819S2-T08-3/mai…
marcus-pzj Apr 14, 2019
cc3cd1d
Fix broken links
marcus-pzj Apr 14, 2019
d29fe04
Remove unused params and exceptions
marcus-pzj Apr 14, 2019
8d2fb95
Fix checkstyle
marcus-pzj Apr 14, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -650,7 +650,7 @@ The maximum Levenshtein Distance set in `PlanMySem` is 20.
The weighted `Slots` are inserted into a `PriorityQueue` and the closest matching `Slots`
will be polled into the output list. +

Upon executing the `find` command with valid parameters (refer to <<UserGuide#view, UserGuide.adoc>> for `find` usage),
Upon executing the `find` command with valid parameters,
a sequence of events is executed. The sequence of events illustrated in the Sequence Diagram below will be in reference to the execution
of a `find n/keyword` command. The sequence of events are as follows:

Expand Down
8 changes: 4 additions & 4 deletions docs/team/marcus-pzj.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,12 @@ image::FindListHistoryActivityDiagram.png[width="800"]
Essentially, if the user knows the exact keyword to use to locate his/her desired [blue]`Slot`, he would use the `list` command.
Otherwise, the `find` command is recommended for use. As a parallel process, [blue]`CommandHistory` records the user input and saves it to [blue]`Planner's` history.

* *Code contributed*: [https://nuscs2113-ay1819s2.github.io/dashboard-beta/#search=marcus-pzj&sort=displayName&since=2019-02-10&until=2019-04-01&timeframe=day&reverse=false&groupSelect=groupByRepos&breakdown=false&tabAuthor=marcus-pzj&tabRepo=CS2113-AY1819S2-T08-3_main_master[RepoSense]] [https://github.com/CS2113-AY1819S2-T08-3/main/pulls?q=is%3Apr+author%3Amarcus-pzj+is%3Aclosed[Pull Requests]]
* *Code contributed*: [https://nuscs2113-ay1819s2.github.io/dashboard-beta/#search=marcus-pzj&sort=displayName&since=2019-02-10&until=2019-04-14&timeframe=day&reverse=false&groupSelect=groupByRepos&breakdown=false&tabAuthor=marcus-pzj&tabRepo=CS2113-AY1819S2-T08-3_main_master&repoSort=true[RepoSense]] [https://github.com/CS2113-AY1819S2-T08-3/main/pulls?q=is%3Apr+author%3Amarcus-pzj+is%3Aclosed[Pull Requests]]

* *Other contributions*:

** Project management:
*** I managed releases from version 1.1 to 1.3, which are all of the https://github.com/CS2113-AY1819S2-T08-3/main/releases[releases] on GitHub.
*** I managed releases from version 1.1 to 1.4, which are all of the https://github.com/CS2113-AY1819S2-T08-3/main/releases[releases] on GitHub.
** Enhancement to existing features:
*** I wrote additional tests for existing features to increase coverage.
** Documentation:
Expand Down Expand Up @@ -161,7 +161,7 @@ Here are the links to my contributed sections in the Developer Guide:

- List Command: https://github.com/CS2113-AY1819S2-T08-3/main/blob/master/docs/DeveloperGuide.adoc#list-feature[`list`]
- Find Command: https://github.com/CS2113-AY1819S2-T08-3/main/blob/master/docs/DeveloperGuide.adoc#find-feature[`find`]
- Undo & Redo Command: https://github.com/CS2113-AY1819S2-T08-3/main/blob/master/docs/DeveloperGuide.adoc#undo-redo-feature[`undo` & `redo`]
- Undo & Redo Command: https://github.com/CS2113-AY1819S2-T08-3/main/blob/master/docs/DeveloperGuide.adoc#undoredo-feature[`undo` & `redo`]
- User Stories: https://github.com/CS2113-AY1819S2-T08-3/main/blob/master/docs/DeveloperGuide.adoc#user-stories[User Stories]

Below is an example of my addition to the Developer Guide for the `find` feature.
Expand All @@ -185,7 +185,7 @@ The maximum Levenshtein Distance set in *PlanMySem* is 20.
The weighted [blue]`Slots` are inserted into a [blue]`PriorityQueue` and the closest matching [blue]`Slots`
will be polled into the output list. +

Upon executing the `find` command with valid parameters (refer to <<UserGuide#view, UserGuide.adoc>> for `find` usage),
Upon executing the `find` command with valid parameters,
a sequence of events is executed. The sequence of events illustrated in the Sequence Diagram below will be in reference to the execution
of a `find n/keyword` command. The sequence of events are as follows:

Expand Down
4 changes: 2 additions & 2 deletions src/planmysem/common/Messages.java
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ public static String craftListMessageWeighted(List<WeightedName> tries) {
sb.append("\n");
count++;
}
sb.append("\n To view more information about the slot, try the 'view day' command!");
sb.append("\n To view more information about a particular slot, try the 'view day' command!");
return sb.toString();
}

Expand Down Expand Up @@ -138,7 +138,7 @@ public static String craftListMessage(List<Pair<LocalDate, Pair<ReadOnlyDay, Rea
sb.append("\n");
count++;
}
sb.append("\n To view more information about the slot, try the 'view day' command!");
sb.append("\n To view more information about a particular slot, try the 'view day' command!");
return sb.toString();
}

Expand Down
3 changes: 1 addition & 2 deletions src/planmysem/logic/commands/ListCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
import javafx.util.Pair;
import planmysem.common.Messages;
import planmysem.logic.CommandHistory;
import planmysem.logic.parser.exceptions.ParseException;
import planmysem.model.Model;
import planmysem.model.semester.Day;
import planmysem.model.semester.ReadOnlyDay;
Expand Down Expand Up @@ -44,7 +43,7 @@ public ListCommand(String name, String tag) {
this.isListAll = false;
}

public ListCommand(String option) throws ParseException {
public ListCommand() {
this.keyword = null;
this.isListByName = false;
this.isListAll = true;
Expand Down
2 changes: 1 addition & 1 deletion src/planmysem/logic/parser/ListCommandParser.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public ListCommand parse(String args) throws ParseException {
String option = getStartingArgument(args);

if (option != null && option.equalsIgnoreCase("all")) {
return new ListCommand(option);
return new ListCommand();
}
if (name == null && tag == null) {
throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, ListCommand.MESSAGE_USAGE));
Expand Down
12 changes: 6 additions & 6 deletions test/java/planmysem/logic/Commands/ListCommandTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ public void execute_ValidPrefixTagOnly_SameKeyword() throws Exception {
@Test
public void execute_parseAll() throws ParseException {
ListCommandParser listCommandParser = new ListCommandParser();
ListCommand expectedListCommand = new ListCommand("all");
ListCommand expectedListCommand = new ListCommand();

ListCommand actualListCommand = listCommandParser.parse("all");

Expand Down Expand Up @@ -224,7 +224,7 @@ public void execute_slotAcceptedByModel_ListNameSuccessful() {
}

@Test
public void execute_slotAcceptedByModel_ListTagSuccessful() throws Exception {
public void execute_slotAcceptedByModel_ListTagSuccessful() {
Set<String> tags = slotBuilder.generateSlot(1).getTags();
String tagToTest = tags.iterator().next();

Expand All @@ -248,7 +248,7 @@ public void execute_slotAcceptedByModel_ListTagSuccessful() throws Exception {
}

@Test
public void execute_slotAcceptedByModel_ListNameNotFound() throws Exception {
public void execute_slotAcceptedByModel_ListNameNotFound() {
String nameToTest = slotBuilder.generateSlot(1).getName().concat("NotTheSame");

CommandResult commandResult = new ListCommand(nameToTest, null).execute(model, commandHistory);
Expand All @@ -266,7 +266,7 @@ public void execute_slotAcceptedByModel_ListNameNotFound() throws Exception {
}

@Test
public void execute_slotAcceptedByModel_ListTagNotFound() throws Exception {
public void execute_slotAcceptedByModel_ListTagNotFound() {
Set<String> tags = slotBuilder.generateSlot(1).getTags();
String tagToTest = tags.iterator().next();
tagToTest = tagToTest.concat("NotTheSame");
Expand All @@ -289,9 +289,9 @@ public void execute_slotAcceptedByModel_ListTagNotFound() throws Exception {
}

@Test
public void execute_listAll() throws Exception{
public void execute_listAll() {

CommandResult commandResult = new ListCommand("all").execute(model, commandHistory);
CommandResult commandResult = new ListCommand().execute(model, commandHistory);

final List<Pair<LocalDate, Pair<ReadOnlyDay, ReadOnlySlot>>> selectedSlots = new ArrayList<>();

Expand Down