Skip to content

Commit

Permalink
Merge pull request #294 from nur-haziq/UpdateUG
Browse files Browse the repository at this point in the history
Update Glossary section of UG
  • Loading branch information
YHWong20 authored Apr 15, 2024
2 parents 34dd453 + 8f045e2 commit 5b9ea66
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 4 deletions.
24 changes: 24 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -1172,11 +1172,35 @@ If your item does not contain a certain attribute (e.g, no `ITEM_SALE_PRICE`), r

## Glossary

Below, you'll find definitions for terms frequently used throughout this user guide. To help you easily navigate and understand these concepts, the terms are organized in alphabetical order.

### Bash
A computer program that provides a text-based interface and environment for user input. Also, the name of a programming language commonly used for scripting and operating system job control.

### Command Prompt / Command Line / Terminal
A means of interacting with a computer through keyboard typed lines of text, also known as commands. This is in contrast to the currently more popular graphical user interface (GUI), which uses visual elements that users can directly manipulate to perform their desired actions.

### Expiry Date
The date by which a perishable item should be sold or used before it becomes unsuitable for sale or consumption.

### Flags
Special markers used in command line interfaces to modify commands or indicate specific variables. [See Flags in BinBash](#flags)

### Java
Java is a high-level, class-based, object-oriented programming language that is designed to have as few implementation dependencies as possible.

### Operational Items
Supplies or equipment used in the daily operations of a business that are essential for running the business but not sold to customers. [See Item Types in BinBash](#item)

### Placeholders
Symbols or variables in programming and scripting that hold a place for a value that can be specified later. [See Placeholders in BinBash](#placeholders)

### Perishable Items
Goods that have a limited time frame in which they are suitable for sale or use, such as food or certain medical supplies. [See Item Types in BinBash](#item)

### Retail Items
Products intended for sale to consumers. These can range from everyday household items to specialty products. [See Item Types in BinBash](#item)

### Threshold
A predefined limit that, when reached, triggers a specific action, such as an alert message to remind the user of the low stock.

8 changes: 4 additions & 4 deletions docs/team/nur-haziq.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,11 @@ methods in the `ItemList` class.

### Documentation:
- User Guide:
- Created the 'Key Definitions' section of the UG, which aimed to introduce to the user the different item types
- Created the **'Key Definitions'** section of the UG, which aimed to introduce to the user the different item types
within BinBash.
- Detailed the usage of flags and placeholders, explaining their roles in command inputs and documenting conditions
- Detailed the usage of **flags** and **placeholders**, explaining their roles in command inputs and documenting conditions
for valid and invalid data entries, thereby facilitating error-free user interactions.
- Presented a structured explanation of the command format, illustrating how commands, flags, and placeholders
- Presented a structured explanation of the **command format**, illustrating how commands, flags, and placeholders
interact, which aids users in mastering command execution for inventory management.
- Reformatted the `list` command section to condense the information and utilized a tabular format to explain the
various ways to sort inventory based on criteria like cost, sale price, profit, and expiry date.
Expand All @@ -106,5 +106,5 @@ methods in the `ItemList` class.
- Release of v2.0 of the product
- Participated regularly in the peer review process. [Link to PR's reviewed](https://github.com/AY2324S2-CS2113T-T09-2/tp/pulls?q=is%3Apr+is%3Aclosed+reviewed-by%3Anur-haziq+-author%3Anur-haziq)
- Actively participated in code reviews for both the iP and PE-D, with contributions recognized as above average in
- terms of quantity of feedback provided.
terms of quantity of feedback provided.

0 comments on commit 5b9ea66

Please sign in to comment.