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

Docs update #193

Merged
merged 2 commits into from
Apr 14, 2024
Merged

Docs update #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84de67a
Change UG EditCommand description
Apr 14, 2024
48360af
Add instructions for manual testing for help page
Apr 14, 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
16 changes: 14 additions & 2 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ title: Developer Guide
* [**Appendix: Instructions for manual testing**](#appendix-instructions-for-manual-testing)
<!-- TOC -->

<div style="page-break-after: always;"></div>

## **Acknowledgements**

* The formatting for the developer guide is inspired by [AB-3](https://se-education.org/addressbook-level3/DeveloperGuide.html).
Expand Down Expand Up @@ -457,12 +459,22 @@ intuitive command-line commands, saving time and improving efficiency.
## Glossary

* *PID (Product ID)* - A unique number assigned to each product for identification purposes.
* Mainstream OS: Windows, Linux, Unix, macOS
* *Mainstream OS* - Windows, Linux, Unix, macOS

--------------------------------------------------------------------------------------------------------------------

## **Appendix: Instructions for manual testing**

**Viewing Help page**
1. No prerequisites needed. <br><br>

2. Test case 1: `help inflow`<br>
Expected: Help page for `inflow command` will be printed out.<br><br>

Test case 2: `help bleh`<br>
Expected: ```Invalid command. For more information on the commands, use `help`.```
will be printed out as `bleh` in an invalid command keyword.

**Adding a Product**

1. No prerequisites needed. <br><br>
Expand All @@ -479,7 +491,7 @@ intuitive command-line commands, saving time and improving efficiency.

**Editing Product Details**

1. Prerequisites: List all products using `list` command. There should be at least multiple products in the list. <br><br>
1. Prerequisites: List all products using `list` command. There should be at least 2 products in the list. <br><br>

2. Test case 1: `edit 1 n/Updated name d/Updated description`<br>
Expected: The name and description of the product with Product ID (PID) 1 will be changed to `Updated name` and `Updated description` respectively. <br><br>
Expand Down
4 changes: 3 additions & 1 deletion docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@ Format: `help [COMMAND]`
e.g. <code>help</code> will be considered the same as <code>HELP</code> and <code>hELP</code>.
</div>

<div style="page-break-after: always;"></div>

### Example 1
Input:

Expand Down Expand Up @@ -305,7 +307,7 @@ Description: [X]
<!--- @@author Kobot7 --->
## Editing Product Details: `edit`

Edits an existing product in the inventory at the specific PID by the input value(s).
Edits details of an existing product in the inventory.

Format:
```
Expand Down
Loading