diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 302b937ff62..cbc24ae5e55 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -164,7 +164,7 @@ This section describes some noteworthy details on how certain features are imple The seed feature seeds dummy data into SocialBook. In the event that the user clears all the contacts in SocialBook, the user can execute the seed command to seed sample data into the SocialBook and continue trying out its features. -The seed command works just like any other `Command` object and how a `Command` object communicates with the `Model` is explained in the [Logic component](#Logic-component). +The seed command works just like any other `Command` object and how a `Command` object communicates with the `Model` is explained in the [Logic component](#logic-component). The seed command adds a `Person` object, in `SampleDataUtil` to the `Model`, if the `Person` object is not already inside SocialBook. @@ -178,7 +178,7 @@ The following activity diagram summarises what happens when a user executes the The view feature toggles the card status of a contact in SocialBook to either show all of their information or an abridged version of it. -The view command works just like any other `Command` object and how a `Command` object communicates with the `Model` is explained in the [Logic component](#Logic-component). +The view command works just like any other `Command` object and how a `Command` object communicates with the `Model` is explained in the [Logic component](#logic-component). The activity diagram below shows how a view command toggles the card status of a contact: diff --git a/docs/UserGuide.md b/docs/UserGuide.md index b951c21e31b..2f6db73ec8c 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -6,7 +6,7 @@ # SocialBook User Guide -SocialBook is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you are a social worker and can type fast, SocialBook can get your contact management tasks (eg. locate/contact families) done faster than traditional GUI apps. +SocialBook is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you are a social worker based in Singapore and can type fast, SocialBook can get your contact management tasks (eg. locate/contact families) done faster than traditional GUI apps. @@ -302,7 +302,7 @@ _Details coming soon ..._ ### Date of Last Visit * Dates of last visit are optional for contacts, and are denoted by the `d/` prefix. -* Dates of last visit are confined to the `DD-MM-YYYY` format and follows the ISO-8601 calendar system. +* Dates of last visit are confined to the `DD-MM-YYYY` format and range of dates follows the [ISO-8601 calendar system](https://en.wikipedia.org/wiki/ISO_8601). * The date provided must be valid, i.e., either today's date or any date before today. This prevents accidental entering of future dates. * To indicate no date of last visit for a contact, you can `add` a contact without the `d/` prefix, or with a `d/` followed by whitespace. diff --git a/docs/diagrams/LogicClassDiagram.puml b/docs/diagrams/LogicClassDiagram.puml index dc63d6c948c..07a08af7418 100644 --- a/docs/diagrams/LogicClassDiagram.puml +++ b/docs/diagrams/LogicClassDiagram.puml @@ -29,10 +29,10 @@ HiddenOutside ..> Logic LogicManager .right.|> Logic LogicManager -right->"1" ParserClasses -ParserClasses ..> XYZCommand : create > +ParserClasses ..> XYZCommand : creates > XYZCommand -up-|> Command -LogicManager .left.> Command : call > +LogicManager .left.> Command : calls > LogicManager --> Model LogicManager --> Storage @@ -43,5 +43,5 @@ note right of XYZCommand: XYZCommand = AddCommand, \nFindCommand, etc Logic ..> CommandResult LogicManager .down.> CommandResult -Command .up.> CommandResult : create > +Command .up.> CommandResult : creates > @enduml diff --git a/docs/diagrams/ParserClasses.puml b/docs/diagrams/ParserClasses.puml index 83506318828..adf1e492903 100644 --- a/docs/diagrams/ParserClasses.puml +++ b/docs/diagrams/ParserClasses.puml @@ -21,10 +21,10 @@ Class Prefix Class HiddenOutside #FFFFFF HiddenOutside ..> AddressBookParser -AddressBookParser .down.> XYZCommandParser: create > +AddressBookParser .down.> XYZCommandParser: creates > -XYZCommandParser ..> XYZCommand : create > -AddressBookParser ..> Command : use > +XYZCommandParser ..> XYZCommand : creates > +AddressBookParser ..> Command : uses > XYZCommandParser .up.|> Parser XYZCommandParser ..> ArgumentMultimap XYZCommandParser ..> ArgumentTokenizer diff --git a/docs/diagrams/SeedActivityDiagram.puml b/docs/diagrams/SeedActivityDiagram.puml index 0f200fcc4aa..d8e46cbc229 100644 --- a/docs/diagrams/SeedActivityDiagram.puml +++ b/docs/diagrams/SeedActivityDiagram.puml @@ -10,7 +10,7 @@ if () then ([model.hasPerson()]) else ([else]) :add person to model; endif -repeat while () is ([end of for loop == false]) not ([else]) +repeat while () is ([else]) not ([all sample persons in model]) stop @enduml diff --git a/docs/diagrams/ViewActivityDiagram.puml b/docs/diagrams/ViewActivityDiagram.puml index af6aad5e083..96a8b5fad84 100644 --- a/docs/diagrams/ViewActivityDiagram.puml +++ b/docs/diagrams/ViewActivityDiagram.puml @@ -13,7 +13,7 @@ if () then ([valid person's index]) of card; endif else ([else]) - :throw new CommandException(); + :throw exception; endif stop