Skip to content

Commit

Permalink
Merge pull request #270 from fy17ohhh/branch-ug-fix-v1.4
Browse files Browse the repository at this point in the history
Remove repeated information in notes about command format
  • Loading branch information
jeremiahlzz authored Apr 14, 2024
2 parents 25a1db3 + 0644350 commit 8ada39a
Showing 1 changed file with 5 additions and 13 deletions.
18 changes: 5 additions & 13 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ EduConnect is a **desktop app for managing student contacts, optimized for use v
* Items with ``​ after them can be used multiple times including zero times.<br>
e.g. `[t/TAG]…​` can be used as ` ` (i.e. 0 times), `t/tutorial-1`, `t/tutorial-1 t/strong` etc.

* Angular brackets `<CONDITION>` will inform the user of the optional prefix requirements that is used in the command <br>
e.g `<choose 1 only>` `[s/STUDENT_ID]` `[e/EMAIL]` `[h/TELEGRAM_HANDLE]` indicates that only one of these optional prefix must be present in the command

* Parameters can be in any order.<br>
e.g. if the command specifies `n/NAME s/STUDENT_ID`, `s/STUDENT_ID n/NAME` is also acceptable.

Expand All @@ -86,19 +89,6 @@ EduConnect is a **desktop app for managing student contacts, optimized for use v

<box type="info" seamless>

**Notes about optional prefixes:**<br>

* Optional prefixes are contained in square brackets.<br>
e.g `[t/Tag]` or `[l/WEBLINK]` (go to individual commands to see which prefixes are optional)

* By default optional prefix is not a required parameter when inputting commands.

* Angular brackets `<CONDITION>` will inform the user of the optional prefix requirements that is used in the command <br>
e.g `<choose 1 only>` `[s/STUDENT_ID]` `[e/EMAIL]` `[h/TELEGRAM_HANDLE]` indicates that only one of these optional prefix must be present in the command
</box>

<box type="info" seamless>

**Notes about unique identifiers:**<br>

* Unique identifiers are `EMAIL`, `STUDENT_ID` and `TELEGRAM_HANDLE`
Expand Down Expand Up @@ -149,12 +139,14 @@ EduConnect is a **desktop app for managing student contacts, optimized for use v

</box>

<box type="info" seamless>
**Notes about displaying timetables of students:**<br>

* By default, timetables of students are not shown.

* To show or hide timetables of students, use `list` command.

</box>
### Viewing help: `help`

Shows a message explaining how to access the help page. This feature ensures that users can easily understand the functionality and syntax of commands without referring to external documentation.
Expand Down

0 comments on commit 8ada39a

Please sign in to comment.