Skip to content

Commit

Permalink
Merge pull request #267
Browse files Browse the repository at this point in the history
Fix UG issues
  • Loading branch information
CYX22222003 authored Nov 7, 2024
2 parents aefe3cf + f0df837 commit c971a41
Show file tree
Hide file tree
Showing 12 changed files with 33 additions and 33 deletions.
32 changes: 16 additions & 16 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,17 +82,17 @@ any traditional point-and-click management app.
Action | Format, Examples
:--------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:
**[Add](#adding-a-person-add)** | `add n/NAME p/PHONE_NUMBER e/EMAIL [t/TAG]…​` <br> e.g., `add n/James Ho p/91231234 e/[email protected] t/friend t/classmate`
**[Clear](#clearing-all-entries--clear)** | `clear`
**[Delete](#deleting-a-person--delete)** | `delete INDEX`<br> e.g., `delete 3`
**[Edit](#editing-a-person--edit)** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
**[Find by contact information](#locating-persons-by-contact-information-find)** | `find PREFIX/KEYWORD [PREFIX/MORE_KEYWORDS]…​`<br> e.g., `find n/James t/floorball`
**[Delete tag](#deleting-a-persons-tag--deltag)** | `deltag INDEX t/KEYWORD` <br> e.g. `deltag 1 t/friend`
**[Add tag](#adds-tags-to-a-specific-person--addtag)** | `addtag INDEX t/KEYWORD [t/MORE_TAGS]…​` <br> e.g. `addtag 1 t/friend t/classmate`
**[Categorize tag](#categorizing-a-tag--cattag)** | `cattag t/TAG [t/MORE_TAGS…​] CATEGORY` <br> e.g. `cattag t/floorball t/mahjong activity`
**[Undo action](#undo-a-command--undo)** | `undo`
**[Clear](#clearing-all-entries-clear)** | `clear`
**[Delete](#deleting-a-person-delete)** | `delete INDEX`<br> e.g., `delete 3`
**[Edit](#editing-a-person-edit)** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
**[Find by contact information](#finding-persons-by-contact-information-find)** | `find PREFIX/KEYWORD [PREFIX/MORE_KEYWORDS]…​`<br> e.g., `find n/James t/floorball`
**[Delete tag](#deleting-a-persons-tag-deltag)** | `deltag INDEX t/KEYWORD` <br> e.g. `deltag 1 t/friend`
**[Add tag](#adds-tags-to-a-specific-person-addtag)** | `addtag INDEX t/KEYWORD [t/MORE_TAGS]…​` <br> e.g. `addtag 1 t/friend t/classmate`
**[Categorize tag](#categorizing-a-tag-cattag)** | `cattag t/TAG [t/MORE_TAGS…​] CATEGORY` <br> e.g. `cattag t/floorball t/mahjong activity`
**[Undo action](#undo-a-command-undo)** | `undo`
**[Redo action](#redo-a-command-redo)** | `redo`
**[List](#listing-all-persons--list)** | `list`
**[Help](#viewing-help--help)** | `help`
**[List](#listing-all-persons-list)** | `list`
**[Help](#viewing-help-help)** | `help`

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

Expand All @@ -106,7 +106,7 @@ When clicked, this hyperlink will show the help page.

Format: `help`

### Adding a person: `add`
### Adding a person : `add`

Adds a person to CampusConnect.

Expand Down Expand Up @@ -143,14 +143,14 @@ Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [t/TAG]…​`
* When editing tags, the existing tags of the person will be removed, i.e. adding of tags is not cumulative.
* You can remove all the person’s tags by typing `t/` without
specifying any tags after it.
* After editing the person, there should be no duplicate contact in the campus connect.
* After editing the person, there should be no duplicate contact in CampusConnect.
* Two contacts are considered duplicates if they share the same name, email, or phone number.

Examples:
* `edit 1 p/91234567 e/[email protected]` Edits the phone number and email address of the 1st person to be `91234567` and `[email protected]` respectively.
* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.

### Locating persons by contact information: `find`
### Finding persons by contact information : `find`

Finds persons whose names, email address, contact number, or tag contain any of the given keywords.

Expand Down Expand Up @@ -258,16 +258,16 @@ Format: `undo`

* Reverts the state of CampusConnect to the one before the most recent command, if any.
* When the oldest version of CampusConnect is reached, `undo` command will cause an exception to be thrown
* Only the command that modify the data of CampusConnect can be undone. Commands such as `list` and `find` will not be undone.
* Only commands that modify the data of CampusConnect can be undone. Commands such as `list` and `find` will not be undone.

### Redo a command: `redo`
### Redo a command : `redo`

Reapplies a command that was previously undone by `undo`.

Format: `redo`

* Advances CampusConnect to the state it was in before the most recent `undo` command, if any.
* Only the command that modify the data of CampusConnect can be redone. Commands such as `list` and `find` will not be redone.
* Only commands that modify the data of CampusConnect can be redone. Commands such as `list` and `find` will not be redone.
* Note: If a new command (excluding `redo` or `undo`) is executed after an `undo`, the redo history is cleared, and further `redo` will not be possible.

### Clearing all entries : `clear`
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/seedu/address/logic/Logic.java
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public interface Logic {
ObservableList<Tag> getListOfCurrentTags();

/**
* Returns the user prefs' campus connect file path.
* Returns the user prefs' CampusConnect file path.
*/
Path getCampusConnectFilePath();

Expand Down
6 changes: 3 additions & 3 deletions src/main/java/seedu/address/logic/commands/AddCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@
import seedu.address.model.person.Person;

/**
* Adds a person to the campus connect.
* Adds a person to CampusConnect.
*/
public class AddCommand extends Command {

public static final String COMMAND_WORD = "add";

public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a person to the campus connect. "
public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a person to CampusConnect. "
+ "Parameters: "
+ PREFIX_NAME + "NAME "
+ PREFIX_PHONE + "PHONE "
Expand All @@ -33,7 +33,7 @@ public class AddCommand extends Command {
+ PREFIX_TAG + "owesMoney";

public static final String MESSAGE_SUCCESS = "New person added: %1$s";
public static final String MESSAGE_DUPLICATE_PERSON = "This person already exists in the campus connect";
public static final String MESSAGE_DUPLICATE_PERSON = "This person already exists in CampusConnect";

private final Person toAdd;

Expand Down
4 changes: 2 additions & 2 deletions src/main/java/seedu/address/logic/commands/ClearCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
import seedu.address.model.Model;

/**
* Clears the campus connect.
* Clears CampusConnect
*/
public class ClearCommand extends Command {

public static final String COMMAND_WORD = "clear";
public static final String MESSAGE_SUCCESS = "Campus Connect has been cleared!";
public static final String MESSAGE_SUCCESS = "CampusConnect has been cleared!";


@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
import seedu.address.model.person.Person;

/**
* Deletes a person identified using it's displayed index from the campus connect.
* Deletes a person identified using it's displayed index from CampusConnect.
*/
public class DeleteCommand extends Command {

Expand Down
4 changes: 2 additions & 2 deletions src/main/java/seedu/address/logic/commands/EditCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import seedu.address.model.tag.Tag;

/**
* Edits the details of an existing person in the campus connect.
* Edits the details of an existing person in the CampusConnect.
*/
public class EditCommand extends Command {

Expand All @@ -47,7 +47,7 @@ public class EditCommand extends Command {

public static final String MESSAGE_EDIT_PERSON_SUCCESS = "Edited Person: %1$s";
public static final String MESSAGE_NOT_EDITED = "At least one field to edit must be provided.";
public static final String MESSAGE_DUPLICATE_PERSON = "This person already exists in the campus connect.";
public static final String MESSAGE_DUPLICATE_PERSON = "This person already exists in CampusConnect.";

private final Index index;
private final EditPersonDescriptor editPersonDescriptor;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ public class ExitCommand extends Command {

public static final String COMMAND_WORD = "exit";

public static final String MESSAGE_EXIT_ACKNOWLEDGEMENT = "Exiting Campus Connect as requested ...";
public static final String MESSAGE_EXIT_ACKNOWLEDGEMENT = "Exiting CampusConnect as requested...";

@Override
public CommandResult execute(Model model) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import seedu.address.model.Model;

/**
* Lists all persons in the campus connect to the user.
* Lists all persons in CampusConnect to the user.
*/
public class ListCommand extends Command {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
*/
public class RedoCommand extends Command {
public static final String COMMAND_WORD = "redo";
public static final String MESSAGE_SUCCESS = "Campus Connect has gone back to the future!";
public static final String MESSAGE_SUCCESS = "CampusConnect has gone back to the future!";

@Override
public CommandResult execute(Model model) throws CommandException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
*/
public class UndoCommand extends Command {
public static final String COMMAND_WORD = "undo";
public static final String MESSAGE_SUCCESS = "Campus Connect has recovered!";
public static final String MESSAGE_SUCCESS = "The previous command has been undone!";

@Override
public CommandResult execute(Model model) throws CommandException {
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/seedu/address/model/CampusConnect.java
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,9 @@ public void addPerson(Person p, int ind) {

/**
* Replaces the given person {@code target} in the list with {@code editedPerson}.
* {@code target} must exist in the campus connect.
* {@code target} must exist in CampusConnect.
* The person identity of {@code editedPerson} must not be the same as
* another existing person in the campus connect.
* another existing person in CampusConnect.
*/
public void setPerson(Person target, Person editedPerson) {
requireNonNull(editedPerson);
Expand All @@ -137,7 +137,7 @@ public void setPerson(Person target, Person editedPerson) {

/**
* Removes {@code key} from this {@code CampusConnect}.
* {@code key} must exist in the campus connect.
* {@code key} must exist in CampusConnect
*/
public void removePerson(Person key) {
persons.remove(key);
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/seedu/address/model/ModelManager.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public class ModelManager implements Model {
public ModelManager(ReadOnlyCampusConnect campusConnect, ReadOnlyUserPrefs userPrefs) {
requireAllNonNull(campusConnect, userPrefs);

logger.fine("Initializing with campus connect: " + campusConnect + " and user prefs " + userPrefs);
logger.fine("Initializing CampusConnect: " + campusConnect + " and user prefs " + userPrefs);

this.campusConnect = new CampusConnect(campusConnect);
this.userPrefs = new UserPrefs(userPrefs);
Expand Down

0 comments on commit c971a41

Please sign in to comment.