Skip to content

Commit

Permalink
Merge pull request #254 from ForAeons/ug-improve-find-command
Browse files Browse the repository at this point in the history 
docs: update user guide and make find command docs consistent
  • Loading branch information
@wxiaoyun
wxiaoyun authored Apr 8, 2024
2 parents 4c28fdf + a598002 commit e6ee217
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -256,12 +256,20 @@ This command differs from most other commands that use the `NUSNET_ID` to identi

Finds students whose names contain any of the given keywords.

Format: `find KEYWORD [MORE_KEYWORDS]`
Format: `find KEYWORD [MORE_KEYWORDS]…​`

<box type="info" seamless>

**Parameters of `find` command:**

- `KEYWORD` is the first keyword to search for. This is a compulsory parameter.
- `[MORE_KEYWORDS]…​` are additional, optional keywords to search for. You can have any number of additional keywords.

</box>

<box type="info" seamless>

**About the find command:**
**About the `find` command:**

<box type="success" seamless>

Expand Down Expand Up @@ -523,7 +531,7 @@ If you move the application to a secondary screen, and later switch to using onl
| **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [m/MAJOR] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/jameslee@example.com` |
| **Mark** | `mark nn/NUSNET_ID wk/WEEK_NUMBER`<br> e.g., `mark nn/e1234567 wk/3` |
| **Unmark** | `unmark nn/NUSNET_ID wk/WEEK_NUMBER`<br> e.g., `unmark nn/e1234567 wk/3` |
| **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` |
| **Find** | `find KEYWORD [MORE_KEYWORDS]…​`<br> e.g., `find James Jake` |
| **Set Course** | `setcrs COURSE_NAME` |
| **List** | `list` |
| **Help** | `help` |
Expand Down

0 comments on commit e6ee217

Please sign in to comment.