Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update UG #239

Merged
merged 2 commits into from
Apr 15, 2024
Merged

Update UG #239

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8eb012
Update UG
JiaXinEu Apr 15, 2024
3230ffe
Update UG
JiaXinEu Apr 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -606,22 +606,23 @@ Displayed after the command: `summary`

## 11. Command summary

| Action | Format, Examples |
|-----------------|-------------------------------------------------------------------------------------------------------------------------------------|
| **Add** | `add id/STUDENT_ID n/NAME e/EMAIL g/GRADE [gp/GROUP_NAME]...` <br> e.g., `add id/A0123459X n/James Doe e/[email protected] g/A` |
| **Delete** | `delete STUDENT_ID`<br> e.g., `delete A0123456X` |
| **Edit** | `edit STUDENT_ID [id/STUDENT_ID] [n/NAME] [e/EMAIL] [g/GRADE] [gp/GROUP_NAME]...` <br> e.g.,`edit A0123466C g/A+` |
| **View** | `view STUDENT_ID`<br> e.g., `view A0123466D` |
| **Group** | `group gp/GROUP_NAME id/STUDENT_ID_1 [id/STUDENT_ID_2] ...` <br> e.g., `group gp/Group 1 id/A1234567R, id/A2345678R` |
| **Random Group** | `random NUMBER_OF_GROUPS gp/GROUP_NAME` <br> e.g., `random 3 gp/Random Group` |
| **Weak** | `setweak g/GRADE` <br> e.g., `setweak g/B` |
| **Summary** | e.g., `summary` <br> |
| **Archive** | `archive STUDENT_ID` <br> e.g., `archive A0123459X` |
| **Unarchive** | `unarchived STUDENT_ID` <br> e.g., `unarchived A0123459X` |
| **EditArchive** | `edit_archived STUDENT_ID [id/STUDENT_ID] [n/NAME] [e/EMAIL] [g/GRADE] [gp/GROUP_NAME]...` <br> e.g., `edit_archived A0123459X g/B` |
| Action | Format, Examples |
|-------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| **Add** | `add id/STUDENT_ID n/NAME e/EMAIL g/GRADE [gp/GROUP_NAME]...` <br> e.g., `add id/A0123459X n/James Doe e/[email protected] g/A` |
| **Delete** | `delete STUDENT_ID`<br> e.g., `delete A0123456X` |
| **Edit** | `edit STUDENT_ID [id/STUDENT_ID] [n/NAME] [e/EMAIL] [g/GRADE] [gp/GROUP_NAME]...` <br> e.g.,`edit A0123466C g/A+` |
| **View** | `view STUDENT_ID`<br> e.g., `view A0123466D` |
| **Group** | `group gp/GROUP_NAME id/STUDENT_ID_1 [id/STUDENT_ID_2] ...` <br> e.g., `group gp/Group 1 id/A1234567R, id/A2345678R` |
| **Random Group** | `random NUMBER_OF_GROUPS gp/GROUP_NAME` <br> e.g., `random 3 gp/Random Group` |
| **Weak** | `setweak g/GRADE` <br> e.g., `setweak g/B` |
| **Filter Group** | `find gp/GROUP_NAME ...` <br> e.g., `find gp/Group 1` |
| **Summary** | e.g., `summary` <br> |
| **Archive** | `archive STUDENT_ID` <br> e.g., `archive A0123459X` |
| **Unarchive** | `unarchived STUDENT_ID` <br> e.g., `unarchived A0123459X` |
| **EditArchive** | `edit_archived STUDENT_ID [id/STUDENT_ID] [n/NAME] [e/EMAIL] [g/GRADE] [gp/GROUP_NAME]...` <br> e.g., `edit_archived A0123459X g/B` |
| **DeleteArchive** | `delete_archived STUDENT_ID` <br> e.g., `delete_archived A0123459X` |
| **ClearArchive** | `clear_archived` |
| **Help** | `help` |
| **Clear** | `clear` |
| **Exit** | `exit` |
| **ClearArchive** | `clear_archived` |
| **Help** | `help` |
| **Clear** | `clear` |
| **Exit** | `exit` |

Loading