Skip to content

Commit

Permalink
Merge pull request #274 from Tim-Siu/final-fixes-shuyao
Browse files Browse the repository at this point in the history
Add documentation of time converting behavior, correct UG `sort` outd…
  • Loading branch information
Nauxe authored Nov 14, 2023
2 parents b37362f + 5ca9ce3 commit a0efe61
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`<br>
**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
Expand Down Expand Up @@ -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`<br>
**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`<br>
**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
Expand Down
16 changes: 12 additions & 4 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<br>


* `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.

</div>

**Example**: `add i 3 n/Marketing Intern 2024 d/Conduct market research and analysis s/20-02-2024 09:45`
Expand Down Expand Up @@ -757,11 +762,14 @@ specified time period.

**:pencil: Parameter Information**<br>

* `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<br>
* `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. <br>

* `START_DATETIME` must be before `END_DATETIME`<br>
* No companies or error message will be shown otherwise.<br>
* Otherwise, error message `Invalid command format...` will be thrown.<br>

* `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)<br>
Expand Down

0 comments on commit a0efe61

Please sign in to comment.