Fix comments

starsia · Apr 15, 2024 · 6cdf018 · 6cdf018
1 parent 7b6efbf
commit 6cdf018
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 11 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -319,8 +319,8 @@ Recalling that we also have a message box to inform the result of the actions ta
     * Cons: JSON files can be difficult to amend and maintain.
 
 * **Alternative 2 (previously implemented)**: Store the Related List as a .txt file.
-    * Pros: Easier to edit, maintain, and implement.
-    * Cons: Not secure, and save and load implementation is exposed outside the NetConnect model.
+    * Pros: Easier to edit, and implement.
+    * Cons: Harder to maintain as there will be multiple files to be used by our application. Save and load implementation is also exposed outside the NetConnect model.
 
 * **Alternative 3**: Store Relations as another field in every person. A relate command would add the opposing contact to both persons provided. 
     * Pros: Easy to understand as a user. Querying of contacts will also be fast as the relations are stored within the same contact. 
@@ -577,10 +577,6 @@ The following activity diagram summarizes what happens when a user executes a ne
 
 _{more aspects and alternatives to be added}_
 
-### \[Proposed\] Data archiving
-
-_{Explain here how the data archiving feature will be implemented}_
-
 --------------------------------------------------------------------------------------------------------------------
 
 ## **Documentation, logging, testing, configuration, dev-ops**

diff --git a/docs/diagrams/RelateActivityDiagram.puml b/docs/diagrams/RelateActivityDiagram.puml
@@ -9,10 +9,10 @@ start
 :User executes relate command;
 
 if () then ([else])
-    :Display error message;
+    :Show error message;
 else ([two numeric IDs provided])
     if () then ([else])
-        :Display error message;
+        :Show error message;
     else ([Both IDs exist])
         :Relate both profiles to each other;
         :Display both profiles that are related;

diff --git a/docs/diagrams/ShowRelatedActivityDiagram.puml b/docs/diagrams/ShowRelatedActivityDiagram.puml
@@ -10,7 +10,7 @@ start
 
 
 if () then ([else])
-    :Display error message;
+    :Show error message;
 else ([One valid number (Integer and greater than 0) provided])
     if () then ([has related profile(s)])
         :Display list of related profiles;

diff --git a/docs/diagrams/UnrelateActivityDiagram.puml b/docs/diagrams/UnrelateActivityDiagram.puml
@@ -9,10 +9,10 @@ start
 :User executes unrelate command;
 
 if () then ([else])
-    :Display error message;
+    :Show error message;
 else ([two numeric IDs provided])
     if () then ([else])
-        :Display error message;
+        :Show error message;
     else ([Both IDs exist])
         :Unrelate both profiles to each other;
         :Display both profiles that have been unrelated;