UG and DG Enhancements and Fix Find Command #132
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
guanquann
reviewed
Apr 9, 2024
docs/DeveloperGuide.md
Outdated
|
|
||
| Team size: 4 | ||
|
|
||
| 4. The current implementation of the find command allows users to search for contacts based on their names, tags, or company names. However, it does not support searching by address, email, or phone number. We acknowledge that the ability to search by these fields can significantly enhance user experience by providing more flexibility and efficiency in locating contact information. The initial decision to exclude address, email, and phone number from the search criteria was based on a focus on the most commonly used identifiers for quick search and to maintain simplicity in the search interface. We also considered the privacy implications and the less frequent necessity of searching by personal information such as phone numbers or addresses. However, in order to enhance the utility of our contact management system, we are planning to introduce expanded search capabilities. This will include the ability to search for contacts by their phone numbers, email addresses, and physical addresses. This enhancement aims to provide a comprehensive search functionality that meets the needs of all users, making the tool more versatile and efficient for locating specific entries. |
There was a problem hiding this comment.
I think it would be better if you follow the format given in Week 12 Project section (the bold text at the start)
guanquann
reviewed
Apr 9, 2024
guanquann
reviewed
Apr 9, 2024
Comment on lines
-21
to
+27
| + "Parameters: n/KEYWORD [MORE_KEYWORDS]... t/KEYWORD [MORE_KEYWORDS]... c/KEYWORD [MORE_KEYWORDS]...\n" | ||
| + "Example: " + COMMAND_WORD + " n/alice t/friends c/Meat \n" | ||
| + "Note: Multiple keywords (name, tag or company) are treated with a logical AND."; | ||
| + "Parameters: [n/NAME_KEYWORDS] [t/TAG_KEYWORDS] [c/COMPANY_KEYWORDS]\n" | ||
| + "Each field is optional, " | ||
| + "but at least one must be provided. All Keywords are combined using logical AND (&&).\n" | ||
| + "Example: " + COMMAND_WORD + " n/alice t/friends c/Meat - " | ||
| + "Finds all persons named 'alice' AND tagged as 'friends' AND who's company name is " | ||
| + "associated with 'Meat'.\n"; | ||
|
|
There was a problem hiding this comment.
Hmm not sure if this violate feature freeze?
There was a problem hiding this comment.
I believe this is just an update to documentation - no change made to the actual command
gavingoh99
changed the title
guanquann
reviewed
Apr 11, 2024
| @@ -583,3 +583,6 @@ to view their newly added order. We plan to show a preview of the order added. F | |||
| 3. **Raise error when an outdated order date is added:** The current date validation does not check if the | |||
| order date is outdated when `addorder` command is called. We plan to raise an error when an outdated order date | |||
| is added. For example: `Order date cannot be in the past`. | |||
|
|
|||
| 4. **Improve Search Functionality**: The current implementation of the find command allows users to search for contacts based on their names, tags, or company names. However, it does not support searching by address, email, or phone number. We acknowledge that the ability to search by these fields can significantly enhance user experience by providing more flexibility and efficiency in locating contact information. The initial decision to exclude address, email, and phone number from the search criteria was based on a focus on the most commonly used identifiers for quick search and to maintain simplicity in the search interface. We also considered the privacy implications and the less frequent necessity of searching by personal information such as phone numbers or addresses. However, in order to enhance the utility of our contact management system, we are planning to introduce expanded search capabilities. This will include the ability to search for contacts by their phone numbers, email addresses, and physical addresses. This enhancement aims to provide a comprehensive search functionality that meets the needs of all users, making the tool more versatile and efficient for locating specific entries. | |||
guanquann
reviewed
Apr 11, 2024
| @@ -235,46 +235,50 @@ Examples: | |||
| - Search feature supports substring search by name and/or tags and/or company **ONLY**. | |||
| - Finds all contacts whose names, tags or company matches the substring keyword provided. | |||
|
|
|||
|
|
|||
| General Format: `find FIELD/ KEYWORD FIELD/ KEYWORD ...` | |||
| General Format: `find [FIELD/KEYWORD] [FIELD/KEYWORD] ...` | |||
There was a problem hiding this comment.
Should the first [FIELD/KEYWORD] be compulsory?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
find#96findby email #91