Skip to content

Commit

Permalink
Fix comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Sia Zhong Qing committed Apr 13, 2024
1 parent 7726c55 commit 15c3aec
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
16 changes: 14 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ If you relate to this problem we identified, then NetConnect might be just right
+ [Exiting the program : `exit`](#exit-program)
+ [Saving the data](#saving-the-data)
+ [Editing the data file](#editing-the-data-file)
* [Future Implementations](#future-implementation)
* [FAQ](#faq)
* [Known issues](#known-issues)
* [Command summary](#command-summary)
Expand Down Expand Up @@ -251,8 +252,6 @@ Format: `relate i/ID i/ID`

Example: `relate i/1 i/2` creates a relation between the profiles with ID of 1 and 2.

**Info:** The relation is stored in a field within Person object, which contains the IDs of any suppliers or clients that they are connected to.

</section>

<section id="showrelated">
Expand All @@ -263,6 +262,10 @@ Shows all the relations associated to a person in the address book.

Format: `showrelated i/ID`

Example: `showrelated i/1` shows all relations between profile 1 and any other contacts.

**Info:** If there are no persons related to the provided ID, the interface will show `0 persons listed`.

</section>

<section id="open-on-last-state">
Expand Down Expand Up @@ -332,6 +335,15 @@ Furthermore, certain edits can cause the NetConnect to behave in unexpected ways

</section>


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

# Future Implementations
The NetConnect team is working on new features and fixes for you, but they are unfortunately unavailable in this current implementation. We intend to have future fixes for these occurences below!

1. When invoking showrelated on a id that does not exist, the error message will be `Contact not found` instead of `0 persons listed`.


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

# FAQ
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/seedu/address/model/util/RelatedList.java
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,10 @@ public boolean hasId(IdTuple idTuple) {
}

/**
* Adds a related person to the list.
* Removes a idTuple from the RelatedList.
*
* @param idTuple The related person to be added.
* @return True if the related person is added, false otherwise.
* @param idTuple The relation to be deleted.
* @return True if the relation is deleted, false otherwise.
*/
public boolean removeTuple(IdTuple idTuple) {
requireNonNull(idTuple);
Expand Down

0 comments on commit 15c3aec

Please sign in to comment.