From 1d89db6a894824dabbf0efdcb987d2e14a5d5193 Mon Sep 17 00:00:00 2001 From: Tim-Siu Date: Tue, 14 Nov 2023 12:22:58 +0800 Subject: [PATCH 1/2] Add documentation of time converting behavior, correct UG `sort` outdated information regarding error message --- docs/DeveloperGuide.md | 4 ++-- docs/UserGuide.md | 16 ++++++++++++---- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 2574084e2c3..988623c6d31 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -1342,7 +1342,7 @@ testers are expected to do more *exploratory* testing. 2. **Test case:** `add i 2 n/Software Engineer Intern d/Work on software development projects s/15-15-2024 14:00`
**Expected:** No internship is added. Error message is shown in the Command Result Box, indicating that the scheduled interview time is invalid. Note that if the scheduled interview time is in the past, the internship will still be - added. If the internship date's day is set between the last day of a month the 31th of a month in months with fewer than + added. If the internship datetime's day is set between the last day of a month and the 31st of a month in months with fewer than 31 days, the internship will be registered, but the date will be automatically adjusted to the final day of that month. 4. Other incorrect add internship commands to @@ -1486,7 +1486,7 @@ trying the following `edit` commands. After `edit i` is run, the company of the 4. **Test case:** `sort c start/01-03-2024 00:01 end/18-05-2024 00:01`
**Expected:** Only grab is displayed in the list, as it is the only company with an internship within the time range. 5. **Test case:** `sort c start/ILLEGAL_DATETIME`
- **Expected:** Error message `Invalid command format!...` is shown in the Command Result Box. If the start and/or end date's day is set between the last day of a month and the 31th of a month in months with fewer than 31 days, the date is valid and will be automatically adjusted to the final day of that month. Planned enhancement: To + **Expected:** Error message `Invalid command format!...` is shown in the Command Result Box. Note that If the start and/or end datetime's day is set between the last day of a month and the 31st of a month in months with fewer than 31 days, the date is valid and will be automatically adjusted to the final day of that month. Planned enhancement: To show a more specific error message. #### Deleting A Person or A Company diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 5f08f146a87..321780af113 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -273,8 +273,13 @@ Keep track of your dream internships efficiently by adding them to their respect * The `INDEX` depends on the currently displayed list of companies which changes as you sort companies or search for specific companies
+ * `SCHEDULED_INTERVIEW_TIME` can only be used **once** and must be in the format `DD-MM-YYYY HH:mm` where - `DD` is the day, `MM` is the month, `YYYY` is the year and `HH:mm` is the time in 24-hour notation + `DD` is the day, `MM` is the month, `YYYY` is the year and `HH:mm` is the time in 24-hour notation. If the internship + time's day is set between the last day of a month and the 31st of a month in months with fewer than + 31 days, the internship will be registered, but the date will be automatically adjusted to the final day of that + month. + **Example**: `add i 3 n/Marketing Intern 2024 d/Conduct market research and analysis s/20-02-2024 09:45` @@ -757,11 +762,14 @@ specified time period. **:pencil: Parameter Information**
-* `START_DATETIME` and `END_DATETIME` must be in the format `DD-MM-YYYY HH:mm` where `DD` is the day, `MM` is the month, `YYYY` is the - year and `HH:mm` is the time in 24-hour notation
+* `START_DATETIME` and `END_DATETIME` must be in the format `DD-MM-YYYY HH:mm` where `DD` is the day, `MM` is the + month, `YYYY` is the + year and `HH:mm` is the time in 24-hour notation. Note that If the start and/or end time's day is set between the last + day of a month and the 31st of a month in months with fewer than 31 days, the date is valid and will be automatically + adjusted to the final day of that month.
* `START_DATETIME` must be before `END_DATETIME`
- * No companies or error message will be shown otherwise.
+ * Otherwise, error message `Invalid command format...` will be thrown.
* `START_DATETIME` and `END_DATETIME` are non-inclusive (i.e. internships with interviews on `START_DATETIME` or `END_DATETIME` will not be included when sorting)
From 5ca9ce3afabfe0ed2dc0a4b236a4b15ec64ec16d Mon Sep 17 00:00:00 2001 From: Tim-Siu Date: Tue, 14 Nov 2023 12:28:14 +0800 Subject: [PATCH 2/2] Correct typo --- docs/DeveloperGuide.md | 2 +- docs/UserGuide.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 988623c6d31..88df5c893d2 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -1486,7 +1486,7 @@ trying the following `edit` commands. After `edit i` is run, the company of the 4. **Test case:** `sort c start/01-03-2024 00:01 end/18-05-2024 00:01`
**Expected:** Only grab is displayed in the list, as it is the only company with an internship within the time range. 5. **Test case:** `sort c start/ILLEGAL_DATETIME`
- **Expected:** Error message `Invalid command format!...` is shown in the Command Result Box. Note that If the start and/or end datetime's day is set between the last day of a month and the 31st of a month in months with fewer than 31 days, the date is valid and will be automatically adjusted to the final day of that month. Planned enhancement: To + **Expected:** Error message `Invalid command format!...` is shown in the Command Result Box. Note that if the start and/or end datetime's day is set between the last day of a month and the 31st of a month in months with fewer than 31 days, the date is valid and will be automatically adjusted to the final day of that month. Planned enhancement: To show a more specific error message. #### Deleting A Person or A Company diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 321780af113..14423f2851c 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -764,7 +764,7 @@ specified time period. * `START_DATETIME` and `END_DATETIME` must be in the format `DD-MM-YYYY HH:mm` where `DD` is the day, `MM` is the month, `YYYY` is the - year and `HH:mm` is the time in 24-hour notation. Note that If the start and/or end time's day is set between the last + year and `HH:mm` is the time in 24-hour notation. Note that if the start and/or end time's day is set between the last day of a month and the 31st of a month in months with fewer than 31 days, the date is valid and will be automatically adjusted to the final day of that month.