Skip to content

Commit 477d465

Browse files
author
GeNiaaz
committed
Fix accidental .address changes
1 parent 689d642 commit 477d465

File tree

8 files changed

+25
-16
lines changed

8 files changed

+25
-16
lines changed

docs/DevOps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ do the rest.
8181
Here are the steps to create a new release.
8282

8383
1. Update the version number in
84-
[`MainApp.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/projectDescription/MainApp.java).
84+
[`MainApp.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java).
8585
1. Generate a fat JAR file using Gradle (i.e., `gradlew shadow`).
8686
1. Tag the repo with the version number. e.g. `v0.1`
8787
1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR

docs/DeveloperGuide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ The ***Architecture Diagram*** given above explains the high-level design of the
2727

2828
</div>
2929

30-
**`Main`** has two classes called [`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/projectDescription/Main.java) and [`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/projectDescription/MainApp.java). It is responsible for,
30+
**`Main`** has two classes called [`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java
31+
/seedu/address/Main.java) and [`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu
32+
/address/MainApp.java). It is responsible for,
3133
* At app launch: Initializes the components in the correct sequence, and connects them up with each other.
3234
* At shut down: Shuts down the components and invokes cleanup methods where necessary.
3335

docs/SettingUp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ If you plan to use Intellij IDEA (highly recommended):
2323
1. **Import the project as a Gradle project**: Follow the guide [_[se-edu/guides] IDEA: Importing a Gradle project_](https://se-education.org/guides/tutorials/intellijImportGradleProject.html) to import the project into IDEA.<br>
2424
:exclamation: Note: Importing a Gradle project is slightly different from importing a normal Java project.
2525
1. **Verify the setup**:
26-
1. Run the `seedu.projectDescription.Main` and try a few commands.
26+
1. Run the `seedu.address.Main` and try a few commands.
2727
1. [Run the tests](Testing.md) to ensure they all pass.
2828

2929
--------------------------------------------------------------------------------------------------------------------

docs/Testing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ There are two ways to run tests.
2929
This project has three types of tests:
3030

3131
1. *Unit tests* targeting the lowest level methods/classes.<br>
32-
e.g. `seedu.projectDescription.commons.StringUtilTest`
32+
e.g. `seedu.address.commons.StringUtilTest`
3333
1. *Integration tests* that are checking the integration of multiple code units (those code units are assumed to be working).<br>
34-
e.g. `seedu.projectDescription.storage.StorageManagerTest`
34+
e.g. `seedu.address.storage.StorageManagerTest`
3535
1. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.<br>
36-
e.g. `seedu.projectDescription.logic.LogicManagerTest`
36+
e.g. `seedu.address.logic.LogicManagerTest`

docs/tutorials/AddRemark.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@ Looking in the `logic.command` package, you will notice that each existing comma
1919
the commands inherit from the abstract class `Command` which means that they must override `execute()`. Each `Command` returns an instance of `CommandResult` upon success and `CommandResult#feedbackToUser` is printed to the
2020
`ResultDisplay`.
2121

22-
Let’s start by creating a new `RemarkCommand` class in the `src/main/java/seedu/projectDescription/logic/command` directory.
22+
Let’s start by creating a new `RemarkCommand` class in the `src/main/java/seedu/address/logic/command` directory.
2323

2424
For now, let’s keep `RemarkCommand` as simple as possible and print some output. We accomplish that by returning a `CommandResult` with an accompanying message.
2525

2626
**`RemarkCommand.java`:**
2727

2828
``` java
29-
package seedu.projectDescription.logic.commands;
29+
package seedu.address.logic.commands;
3030

31-
import seedu.projectDescription.model.Model;
31+
import seedu.address.model.Model;
3232

3333
/**
3434
* Changes the remark of an existing project in the main catalogue.
@@ -93,7 +93,8 @@ We start by modifying the constructor of `RemarkCommand` to accept an `Index` an
9393
if our code is functioning as intended.
9494

9595
``` java
96-
import static seedu.projectDescription.commons.util.CollectionUtil.requireAllNonNull;
96+
import static seedu.address
97+
.commons.util.CollectionUtil.requireAllNonNull;
9798
//...
9899
public class RemarkCommand extends Command {
99100
//...
@@ -143,7 +144,9 @@ Your code should look something like [this](https://github.com/se-edu/addressboo
143144

144145
Now let’s move on to writing a parser that will extract the index and remark from the input provided by the user.
145146

146-
Create a `RemarkCommandParser` class in the `seedu.projectDescription.logic.parser` package. The class must extend the `Parser` interface.
147+
Create a `RemarkCommandParser` class in the `seedu.address
148+
.logic.parser` package. The class must extend the `Parser
149+
` interface.
147150

148151
![The relationship between Parser and RemarkCommandParser](../images/add-remark/ParserInterface.png)
149152

@@ -235,7 +238,9 @@ Now that we have all the information that we need, let’s lay the groundwork fo
235238

236239
### Add a new `Remark` class
237240

238-
Create a new `Remark` in `seedu.projectDescription.model.project`. Since a `Remark` is a field that is similar to `Address`, we can reuse a significant bit of code.
241+
Create a new `Remark` in `seedu.address
242+
.model.project`. Since a `Remark` is a field that is similar to `Address`, we can
243+
reuse a significant bit of code.
239244

240245
A copy-paste and search-replace later, you should have something like
241246
[this](https://github.com/se-edu/addressbook-level3/commit/4516e099699baa9e2d51801bd26f016d812dedcc#diff-af2f075d24dfcd333876f0fbce321f25). Note how `Remark` has no
@@ -251,7 +256,9 @@ These should be relatively simple changes.
251256

252257
Without getting too deep into `fxml`, let’s go on a 5 minute adventure to get some placeholder text to show up for each project.
253258

254-
Simply add the following to [`seedu.projectDescription.ui.ProjectCard`](https://github.com/se-edu/addressbook-level3/commit/850b78879582f38accb05dd20c245963c65ea599#diff-0c6b6abcfac8c205e075294f25e851fe).
259+
Simply add the following to [`seedu.address
260+
.ui.ProjectCard`](https://github.com/se-edu/addressbook-level3/commit
261+
/850b78879582f38accb05dd20c245963c65ea599#diff-0c6b6abcfac8c205e075294f25e851fe).
255262

256263
**`ProjectCard.java`:**
257264

docs/tutorials/TracingCode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Before we proceed, ensure that you have done the following:
3232

3333
## Setting a break point
3434

35-
As you know, the first step of debugging is to put in a breakpoint where you want the debugger to pause the execution. For example, if you are trying to understand how the App starts up, you would put a breakpoint in the first statement of the `main` method. In our case, we would want to begin the tracing at the very point where the App start processing user input (i.e., somewhere in the UI component), and then trace through how the execution proceeds through the UI component. However, the execution path through a GUI is often somewhat obscure due to various *event-driven mechanisms* used by GUI frameworks, which happens to be the case here too. Therefore, let us put the breakpoint where the UI transfers control to the Logic component. According to the sequence diagram, the UI component yields control to the Logic component through a method named `execute`. Searching through the code base for `execute()` yields a promising candidate in `seedu.projectDescription.ui.CommandBox.CommandExecutor`.
35+
As you know, the first step of debugging is to put in a breakpoint where you want the debugger to pause the execution. For example, if you are trying to understand how the App starts up, you would put a breakpoint in the first statement of the `main` method. In our case, we would want to begin the tracing at the very point where the App start processing user input (i.e., somewhere in the UI component), and then trace through how the execution proceeds through the UI component. However, the execution path through a GUI is often somewhat obscure due to various *event-driven mechanisms* used by GUI frameworks, which happens to be the case here too. Therefore, let us put the breakpoint where the UI transfers control to the Logic component. According to the sequence diagram, the UI component yields control to the Logic component through a method named `execute`. Searching through the code base for `execute()` yields a promising candidate in `seedu.address.ui.CommandBox.CommandExecutor`.
3636

3737
![Using the `Search for target by projectName` feature. `Navigate` \> `Symbol`.](../images/tracing/Execute.png)
3838

src/main/java/seedu/address/model/person/Address.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ public class Address {
2020
public final String value;
2121

2222
/**
23-
* Constructs an {@code ProjectDescription}.
23+
* Constructs an {@code Address}.
2424
*
2525
* @param address A valid address
2626
*/

src/main/java/seedu/address/model/person/Person.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ public String toString() {
138138
.append(getPhone())
139139
.append(" Email: ")
140140
.append(getEmail())
141-
.append(" ProjectDescription: ")
141+
.append(" Address: ")
142142
.append(getAddress())
143143
.append(" Tags: ");
144144
getTags().forEach(builder::append);

0 commit comments

Comments
 (0)