Skip to content

Commit

Permalink
Merge pull request #347 from Originalidk/master
Browse files Browse the repository at this point in the history 
Update table of parameters
  • Loading branch information
@Originalidk
Originalidk authored Nov 14, 2023
2 parents d33618c + 981eddc commit 5f5e41b
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ Most commands given in the user guide utilise various parameters which are also
| MIDTERMS | `mt/` | `editgradedtest` | The Score of a MidTerms exam. <ul><li>Score should be a positive number.</li></ul> |
| FINALS | `f/` | `editgradedtest` | The Score of a Finals exam. <ul><li>Score should be a positive number.</li></ul> |
| PRACTICAL_EXAM | `pe/` | `editgradedtest` | The Score of a Practical exam. <ul><li>Score should be a positive number.</li></ul> |
| ASSIGNMENT | `as/` | `deletecomment` `editcomment` `editgrade` | The Name of an Assignment. <ul><li>Name should exist in the list of possible assignments.</li></ul> |
| ASSIGNMENT | `as/` | `editcomment` `deletecomment` `editgrade` `deletegrade` | The Name of an Assignment. <ul><li>Name should exist in the list of possible assignments.</li></ul> |
| GRADE | `g/` | `editgrade` | The Grade of an Assignment. <ul><li>Grade should be a positive number.</li><li>Grade should be less than or equal to (max grade + 75).</li><li>Grade should not have leading 0's.</li></ul> |
| COMMENT | `c/` | `editcomment` | The Comment of an Assignment. <ul><li>Comment should be less than 200 characters.</li><li>Comment should not be empty.</ul> |
| DATE | `d/` | `addtask` `viewtasks` `createconsult` | The Date. <ul><li>The format must be dd/MM/yyyy.</li></ul> |
Expand Down
22 changes: 11 additions & 11 deletions src/main/java/seedu/address/logic/parser/ParserUtil.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ public static AttendancePresence parseAttendancePresence(String attendancePresen
}

/**
* Parses a {@code String taskName} into a {@code TaskName}.
* Parses a {@code String name} into a {@code TaskName}.
* Leading and trailing whitespaces will be trimmed.
*
* @throws ParseException if the given {@code name} is invalid.
Expand All @@ -259,7 +259,7 @@ public static TaskName parseTaskName(String name) throws ParseException {
}

/**
* Parses a {@code String taskDescription} into a {@code TaskDescription}.
* Parses a {@code String name} into a {@code TaskDescription}.
* Leading and trailing whitespaces will be trimmed.
*
* @throws ParseException if the given {@code name} is invalid.
Expand Down Expand Up @@ -378,7 +378,7 @@ public static void validateGradedTestField(String fieldName, String fieldValue)
}

/**
* Parses {@code Collection<String> gradedTest} into a {@code Set<GradedTest>}.
* Parses {@code Collection<String> gradedTests} into a {@code Set<GradedTest>}.
*/
public static Set<GradedTest> parseGradedTests(Collection<String> gradedTests) throws ParseException {
requireNonNull(gradedTests);
Expand All @@ -390,7 +390,7 @@ public static Set<GradedTest> parseGradedTests(Collection<String> gradedTests) t
}

/**
* Parses a {@code String readingAssessment} into a {@code readingAssessment}.
* Parses a {@code String name} into a {@code readingAssessment}.
* Leading and trailing whitespaces will be trimmed.
*
* @throws ParseException if the given {@code name} is invalid.
Expand All @@ -405,7 +405,7 @@ public static ReadingAssessment1 parseReadingAssessment1(String name) throws Par
}

/**
* Parses a {@code String readingAssessment} into a {@code readingAssessment}.
* Parses a {@code String name} into a {@code readingAssessment}.
* Leading and trailing whitespaces will be trimmed.
*
* @throws ParseException if the given {@code name} is invalid.
Expand All @@ -420,7 +420,7 @@ public static ReadingAssessment2 parseReadingAssessment2(String name) throws Par
}

/**
* Parses a {@code String readingAssessment} into a {@code readingAssessment}.
* Parses a {@code String name} into a {@code readingAssessment}.
* Leading and trailing whitespaces will be trimmed.
*
* @throws ParseException if the given {@code name} is invalid.
Expand All @@ -435,7 +435,7 @@ public static MidTerms parseMidTerms(String name) throws ParseException {
}

/**
* Parses a {@code String finals} into a {@code finals}.
* Parses a {@code String name} into a {@code finals}.
* Leading and trailing whitespaces will be trimmed.
*
* @throws ParseException if the given {@code name} is invalid.
Expand All @@ -450,7 +450,7 @@ public static Finals parseFinals(String name) throws ParseException {
}

/**
* Parses a {@code String practicalExam} into a {@code practicalExam}.
* Parses a {@code String name} into a {@code practicalExam}.
* Leading and trailing whitespaces will be trimmed.
*
* @throws ParseException if the given {@code name} is invalid.
Expand All @@ -465,7 +465,7 @@ public static PracticalExam parsePracticalExam(String name) throws ParseExceptio
}

/**
* Parses a {@code String priority} into a {@code TaskPriority}.
* Parses a {@code String name} into a {@code TaskPriority}.
* Leading and trailing whitespaces will be trimmed.
* String will be uppercase.
*
Expand All @@ -483,7 +483,7 @@ public static TaskPriority parseTaskPriority(String name) throws ParseException
}

/**
* Parses a {@code String progress} into a {@code TaskProgress}.
* Parses a {@code String name} into a {@code TaskProgress}.
* Leading and trailing whitespaces will be trimmed.
* String will be uppercase.
*
Expand All @@ -501,7 +501,7 @@ public static TaskProgress parseTaskProgress(String name) throws ParseException
}

/**
* Parses a {@code String assignmentName} into a {@code AssignmentName}.
* Parses a {@code String name} into a {@code AssignmentName}.
*
* @throws ParseException if the given {@code name} is invalid.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/seedu/address/model/task/TaskDescription.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public TaskDescription(String description) {
}

/**
* Returns true if a given string is a valid tag name.
* Returns true if a given string is a valid task description.
*/
public static boolean isValidDescription(String test) {
return test.matches(VALIDATION_REGEX);
Expand Down

0 comments on commit 5f5e41b

Please sign in to comment.