Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update UG command summary for find #108

Merged
merged 2 commits into from
Oct 17, 2024
Merged

Update UG command summary for find #108

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc12a71
docs: Update command summary for find
Rachael-Chan Oct 17, 2024
2b507f2
docs: Update clarity of find command format
Rachael-Chan Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,9 @@ Examples:

Finds contacts whose names or/and phone numbers or/and address contain any of the given field keywords.

Format: `find n/NAMEKEYWORDS p/PHONEKEYWORDS a/ADDRESSKEYWORDS`
Format: `find [n/NAMEKEYWORDS] [p/PHONEKEYWORDS] [a/ADDRESSKEYWORDS]`

**NOTE:** At least one field MUST be specified
**NOTE:** At least one field MUST be provided
e.g. `find n/Hans` or `find p/12345678` or `find a/wall street` will work
e.g. `find Hans` or `find wall street` or `find` will fail
* The search is case-insensitive. e.g `hans` will match `Hans` or `wall Street` will match `Wall Street`
Expand Down Expand Up @@ -223,7 +223,7 @@ Action | Format, Examples
**Clear** | `clear`
**Delete** | `delete INDEX`<br> e.g., `delete 3`
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​ [d/DATE_OF_LAST_VISIT]`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
**Find** | `find [n/NAMEKEYWORD] [p/PHONEKEYWORD] [a/ADDRESSKEYWORD]`<br> e.g., `find n/James Jake a/clementi street_woodlands`
**List** | `list`
**Help** | `help`
**Seed** | `seed`