Skip to content

Commit

Permalink
Merge pull request #221 from nichee/master
Browse files Browse the repository at this point in the history
Update UG
  • Loading branch information
nichee authored Apr 12, 2024
2 parents e1ed373 + 767f2c3 commit 70a49bc
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 2 deletions.
Binary file added docs/SelectCommand
Binary file not shown.
Binary file added docs/SelectCommandResult
Binary file not shown.
9 changes: 7 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,17 +157,22 @@ Format: `rm INDEX`
Shows list of classes in result display.

![ViewCommand](images/ViewCommand.png)

* The index number shown in the displayed class list is used for "Select" and "Remove". (e.g. CS2101 is index 1)
Format: `view`

### Selecting a class to view : `select`

Shows a list of all students in the selected class.

![SelectCommand](images/SelectCommand.png)

![img_1.png](SelectCommand)
Format: `select INDEX`

* Selects the class at the specified `INDEX`.
* The index refers to the index number shown in the displayed class list. (e.g. CS2101 is index 1)
* The index **must be a positive integer** 1, 2, 3, …​
* Removes class from ClassBook and entire StudentBook from that class as well, i.e. [JAR file location]/data/classbook/[ClassName].json will be simultaneously deleted.

* The subsequent features (i.e. `add`, `delete`, `edit`, `adda`, `dela`, `edita`, `description`, `list`, `find`, `clear`) are to be used after selecting a class.

### Adding a student : `add`
Expand Down
Binary file added docs/img.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 70a49bc

Please sign in to comment.