Skip to content

Commit

Permalink
Update DG print (#304)
Browse files Browse the repository at this point in the history
  • Loading branch information
chongweiguan authored Apr 10, 2023
2 parents 52ce2a1 + 2531571 commit f4ef500
Show file tree
Hide file tree
Showing 7 changed files with 206 additions and 211 deletions.
2 changes: 1 addition & 1 deletion docs/DevOps.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Any warnings or errors will be printed out to the console.

Here are the steps to create a new release.

1. Update the version number in [`MainApp.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java).
1. Update the version number in [`MainApp.java`](https://github.com/AY2223S2-CS2103T-W15-2/tp/blob/master/src/main/java/trackr/MainApp.java).
1. Generate a fat JAR file using Gradle (i.e., `gradlew shadowJar`).
1. Tag the repo with the version number. e.g. `v0.1`
1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created.
25 changes: 16 additions & 9 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Trackr is a desktop application catered towards home businesses to track their _

:bulb: **Tip**

Texts that are in _italics_ are further explained in the [Glossary section](#glossary).
Texts that are in _italics_ are further explained in the [Glossary section](#46-glossary).

</div>

Expand Down Expand Up @@ -65,7 +65,7 @@ You can click on the respective links below to read up on the relevant sections.
* [4.5 Non-Functional Requirements](#45-non-functional-requirements)
* [4.6 Glossary](#46-glossary)
* [4.7 Planned Enhancements](#47-planned-enhancements)
* [4.7 Instructions for manual testing](#47-instructions-for-manual-testing)
* [4.8 Instructions for manual testing](#48-instructions-for-manual-testing)
* [Launch and shutdown](#launch-and-shutdown)
* [Adding a supplier](#adding-a-supplier)
* [Adding a task](#adding-a-task)
Expand Down Expand Up @@ -142,19 +142,19 @@ Given below is a quick overview of main components and how they interact with ea

### 2.1.1 Main components of the architecture

**`Main`** has two classes called [`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java). It is responsible for,
**`Main`** has two classes called [`Main`](https://github.com/AY2223S2-CS2103T-W15-2/tp/blob/master/src/main/java/trackr/Main.java) and [`MainApp`](https://github.com/AY2223S2-CS2103T-W15-2/tp/blob/master/src/main/java/trackr/MainApp.java). It is responsible for,

* At app launch: Initializing the components in the correct sequence, and connecting them up with each other.
* At shut down: Shutting down the components and invoking cleanup methods where necessary.

[**`Commons`**](#common-classes) represents a collection of classes used by multiple other components.
[**`Commons`**](#26-common-classes) represents a collection of classes used by multiple other components.

The rest of the App consists of four components.

* [**`UI`**](#ui-component): The UI of the App.
* [**`Logic`**](#logic-component): The command executor.
* [**`Model`**](#model-component): Holds the data of the App in memory.
* [**`Storage`**](#storage-component): Reads data from, and writes data to, the hard disk.
* [**`UI`**](#22-ui-component): The UI of the App.
* [**`Logic`**](#23-logic-component): The command executor.
* [**`Model`**](#24-model-component): Holds the data of the App in memory.
* [**`Storage`**](#25-storage-component): Reads data from, and writes data to, the hard disk.

### 2.1.2 How the architecture components interact with each other

Expand Down Expand Up @@ -529,6 +529,8 @@ The following activity diagram summarizes what happens when the user executes th
The `ListXYZCommand` is an improved version of the original _AB3_ `ListCommand` by implementing into an abstract class - `ListItemCommand`.
This reduces repeated lines of code and improves ease of implementation for future commands that require listing all item of the same data type.

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

## 3.6 SortXYZCommand

<div markdown="block" class="alert alert-info">
Expand Down Expand Up @@ -996,9 +998,14 @@ Therefore, we plan to improve on this by only allowing users to key in deadlines
Since both `OrderDeadline` and `TaskDeadline` extends the common class `Deadline` and `Deadline::isValidDeadline` is used to check the validity of both parameters,
we plan to simply tweak the implementation of `Deadline::isValidDeadline` for stricter checks on deadlines entered.

**6.** Fix error in `find_order`.
Currently, `find_order` only works on the last field that is typed into the command. Hence, it is ignoring the other fields.
We plan to improve this feature to match `find_task` command where it would match the multiple fields if they are present in an `AND` format.
Specifically, `find_order q/2 d/01/01/2024` would list all orders that have quantity of `2` and a deadline of `01/01/2024`.

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

## 4.7 Instructions for manual testing
## 4.8 Instructions for manual testing

Given below are instructions to test the app manually.

Expand Down
2 changes: 1 addition & 1 deletion docs/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ title: Documentation guide

**Diagrams:**

* See the [_[se-edu/guides] **Using PlantUML**_](https://se-education.org/guides/tutorials/plantUml.html)
* See the guide [_[se-edu/guides] **Using PlantUML**_](https://se-education.org/guides/tutorials/plantUml.html)

**Converting a document to the PDF format:**

Expand Down
2 changes: 1 addition & 1 deletion docs/SettingUp.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ If you plan to use Intellij IDEA (highly recommended):

1. **Learn the design**

When you are ready to start coding, we recommend that you get some sense of the overall design by reading about [Trackr’s architecture](DeveloperGuide.md#architecture).
When you are ready to start coding, we recommend that you get some sense of the overall design by reading about [Trackr’s architecture](DeveloperGuide.md#21-architecture).
4 changes: 2 additions & 2 deletions docs/Testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ There are two ways to run tests.
This project has three types of tests:

1. *Unit tests* targeting the lowest level methods/classes.<br>
e.g. `seedu.address.commons.StringUtilTest`
e.g. `trackr.commons.StringUtilTest`
1. *Integration tests* that are checking the integration of multiple code units (those code units are assumed to be working).<br>
e.g. `trackr.storage.StorageManagerTest`
1. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.<br>
1. Hybrids of unit and integration tests. These test are checking multiple code units as well as how they are connected together.<br>
e.g. `trackr.logic.LogicManagerTest`
6 changes: 3 additions & 3 deletions docs/diagrams/DeleteSequenceDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
participant ":TrackrParser" as TrackrParser LOGIC_COLOR
participant ":DeleteOrderCommandParser" as DeleteOrderCommandParser LOGIC_COLOR
participant "d:DeleteOrderCommand" as DeleteOrderCommand LOGIC_COLOR
participant ":DeleteOrder\nCommandParser" as DeleteOrderCommandParser LOGIC_COLOR
participant "d:DeleteOrder\nCommand" as DeleteOrderCommand LOGIC_COLOR
participant ":CommandResult" as CommandResult LOGIC_COLOR
end box

Expand Down Expand Up @@ -48,7 +48,7 @@ deactivate TrackrParser
LogicManager -> DeleteOrderCommand : execute()
activate DeleteOrderCommand

DeleteOrderCommand -> Model : deleteItem(1, ModelEnum.ORDER)
DeleteOrderCommand -> Model : deleteItem(1,\nModelEnum.ORDER)
activate Model

Model --> DeleteOrderCommand
Expand Down
Loading

0 comments on commit f4ef500

Please sign in to comment.