diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 2bcce52b80a3..2e0a562ca2fb 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -183,6 +183,8 @@ Format: `list` === Listing all groups a person is in : `list` (Melodies) +Short form/Alias: `l` + Shows a list of all groups the person specified by his PERSON_INDEX is in. + Format: `list PERSON_INDEX` diff --git a/docs/team/happytreat.adoc b/docs/team/happytreat.adoc index 33812687a36a..13e07d6dddca 100644 --- a/docs/team/happytreat.adoc +++ b/docs/team/happytreat.adoc @@ -49,6 +49,8 @@ NUS Hangs is a desktop Schedule Manager application. It has a GUI but most user |=== |_Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users._ |=== +include::../UserGuide.adoc[tag=list] + include::../UserGuide.adoc[tag=groups] == Contributions to the Developer Guide diff --git a/src/main/java/seedu/address/logic/commands/EditGroupCommand.java b/src/main/java/seedu/address/logic/commands/EditGroupCommand.java index 8ab0e94eeb8f..5dbe8ee73806 100644 --- a/src/main/java/seedu/address/logic/commands/EditGroupCommand.java +++ b/src/main/java/seedu/address/logic/commands/EditGroupCommand.java @@ -27,7 +27,7 @@ public class EditGroupCommand extends Command { public static final String ALIAS = "eg"; - public static final String MESSAGE_USAGE = COMMAND_WORD + ": Edits the details of the group identified. " + public static final String MESSAGE_USAGE = COMMAND_WORD + ": Edits the details of the group identified " + "by its name. " + "Existing values will be overwritten by the input values.\n" + "Parameters: Current name " diff --git a/src/main/java/seedu/address/logic/commands/FindCommand.java b/src/main/java/seedu/address/logic/commands/FindCommand.java index 3545f26eb2d4..f7aef27bc406 100644 --- a/src/main/java/seedu/address/logic/commands/FindCommand.java +++ b/src/main/java/seedu/address/logic/commands/FindCommand.java @@ -26,12 +26,12 @@ public class FindCommand extends Command { public static final String ALIAS = "f"; public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all person in NUS Hangs " - + "(Prefix Search/ Case-Insensitive) and displays them as a list.\n" + + "(Prefix Search is case-insensitive) and displays them as a list.\n" + "Parameters:\n" - + PREFIX_NAME + "NAME " - + PREFIX_PHONE + "PHONE " - + PREFIX_EMAIL + "EMAIL " - + PREFIX_ADDRESS + "ADDRESS " + + "[" + PREFIX_NAME + "NAME] " + + "[" + PREFIX_PHONE + "PHONE] " + + "[" + PREFIX_EMAIL + "EMAIL] " + + "[" + PREFIX_ADDRESS + "ADDRESS] " + "[" + PREFIX_TAG + "TAG]...\n" + "Example: " + COMMAND_WORD + " " + PREFIX_NAME + "alex " diff --git a/src/main/java/seedu/address/logic/commands/RegisterCommand.java b/src/main/java/seedu/address/logic/commands/RegisterCommand.java index f319305710e2..0af2e816ebd5 100644 --- a/src/main/java/seedu/address/logic/commands/RegisterCommand.java +++ b/src/main/java/seedu/address/logic/commands/RegisterCommand.java @@ -28,7 +28,7 @@ public class RegisterCommand extends Command { public static final String ALIAS = "r"; public static final String MESSAGE_USAGE = COMMAND_WORD + ": Add an existing person to a group. " - + "Parameters: INDEX\n" + + "Parameters: INDEX " + PREFIX_NAME + " GROUP NAME\n" + "Example: " + COMMAND_WORD + " 1 " + PREFIX_NAME + "Family ";