Update find command in UG #312
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
Codecov ReportAll modified and coverable lines are covered by tests ✅ |
notnotmax
reviewed
Nov 9, 2024
docs/UserGuide.md
Outdated
| * The search is case-insensitive. e.g `hans` will match `Hans`, `cs2103t` will match `CS2103T` | ||
| * Can search for names and courses. Use the `n/` prefix to search for names and the `c/` prefix to search for courses. | ||
| * Partial searches will be matched e.g. `Jam` will match `James` and `James Ho` | ||
| * Each sequence of words not separated by `;` or a prefix will be used as a search. This means that `jam ho` will not match `James Ho` | ||
| * Students matching at least one keyword will be returned (i.e. `OR` search). | ||
| e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang` |
There was a problem hiding this comment.
A bit misleading, since in the line above it we say jam ho will not match James Ho. Maybe change this line to say Hans;Bo instead of Hans Bo?
There was a problem hiding this comment.
Additionally, to address #250, maybe you could say that if no keyword is given, the command will show all students?
S-K-Y-Light
requested changes
Nov 10, 2024
docs/UserGuide.md
Outdated
| * The search is case-insensitive. e.g `hans` will match `Hans`, `cs2103t` will match `CS2103T` | ||
| * Can search for names and courses. Use the `n/` prefix to search for names and the `c/` prefix to search for courses. | ||
| * Partial searches will be matched e.g. `Jam` will match `James` and `James Ho` | ||
| * Each sequence of words not separated by `;` or a prefix will be used as a search. This means that `jam ho` will not match `James Ho` | ||
| * Students matching at least one keyword will be returned (i.e. `OR` search). | ||
| e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang` |
There was a problem hiding this comment.
Agreed. This Line is misleading. It definitely needs to be changed.
S-K-Y-Light
approved these changes
Nov 11, 2024
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.
Fixes #306, fixes #292, fixes #288, fixes #287, fixes #260.
Update find command usage in user guide