From 9c6f9066bfc958bafed62c7c3f9eea14b5ba771e Mon Sep 17 00:00:00 2001 From: yuxunn Date: Thu, 9 Nov 2023 20:11:12 +0800 Subject: [PATCH] UG --- docs/UserGuide.md | 16 +++++++++------- .../address/logic/commands/FindCommand.java | 4 ++-- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 6f5dbf4a043..292e9b5d4b8 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -30,7 +30,7 @@ D.A.V.E. is here to enhance your advisory journey by simplifying information man - [Sort meeting time](#sort-meeting-time) - [Convert lead to client](#convert-lead-to-client) - [Convert client to lead](#convert-client-to-lead) - - [Locating person by name](#locating-person-by-name) + - [Locating persons by name](#locating-persons-by-name) - [Clear address book](#clear-address-book) - [Exit the program](#exit-the-program) - [FAQ](#faq) @@ -576,12 +576,12 @@ from current date to ensure a follow-up by the user. `The person index provided is invalid` -### Locating person by name +### Locating persons by name - What it does: Finds persons whose names contain any of the given keywords. -- Command format: `find NAME [MORE_NAMES]` +- Command format: `find KEYWORD [MORE_KEYWORDS]` - Example usage: `find John David` - Acceptable values for parameter: - - `NAME`: Any name from the list. + - `KEYWORD`: Any name from the list. - Precise expected output when the command succeeds: ` persons listed!` @@ -596,9 +596,11 @@ Example: find alice bob charlie ``` - The search is case-insensitive. e.g John will match john. - Only full words will be matched e.g. John will not match Johns. - Persons matching at least one keyword will be returned (i.e. OR search). e.g. find john david will return John Doe, David Li. +
    +
  • The search is case-insensitive. e.g. John will match john.
  • +
  • Only full words will be matched. e.g. John will not match Johns.
  • +
  • Persons matching at least one keyword will be returned (i.e. OR search). e.g. find john david will return John Doe, David Li.
  • +
Example usage: diff --git a/src/main/java/seedu/address/logic/commands/FindCommand.java b/src/main/java/seedu/address/logic/commands/FindCommand.java index f04b419c6ef..72b9eddd3a7 100644 --- a/src/main/java/seedu/address/logic/commands/FindCommand.java +++ b/src/main/java/seedu/address/logic/commands/FindCommand.java @@ -16,8 +16,8 @@ public class FindCommand extends Command { public static final String COMMAND_WORD = "find"; public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all persons whose names contain any of " - + "the specified names (case-insensitive) and displays them as a list with index numbers.\n" - + "Parameters: NAME [MORE_NAMES]...\n" + + "the specified keywords (case-insensitive) and displays them as a list with index numbers.\n" + + "Parameters: KEYWORD [MORE_KEYWORDS]...\n" + "Example: " + COMMAND_WORD + " alice bob charlie"; private final NameContainsKeywordsPredicate predicate;