Update user guide to clarify confusing behaviour raised during PE #214
Conversation
docs/UserGuide.md
Outdated
| @@ -215,7 +215,7 @@ Examples: | |||
|
|
|||
| #### 3.2.4 Listing all students: `list` | |||
|
|
|||
| You can view the list of all students in **Reeve**. | |||
| You can view the list of all students in **Reeve** in order sorted by the name of the student.. | |||
There was a problem hiding this comment.
A better way to phrase this would be "list of all students [...] sorted by name".
docs/UserGuide.md
Outdated
| @@ -559,7 +559,7 @@ Action | Format, Examples | |||
| --------|------------------ | |||
| **Add Student** | `add n/NAME p/PHONE s/SCHOOL y/YEAR v/CLASS_VENUE t/CLASS_TIME f/FEE d/LAST_PAYMENT_DATE [a/ADDITIONAL_DETAILS]...` <br> e.g., `add n/John Doe p/98765432 s/Woodlands Secondary School y/Secondary 2 v/347 Woodlands Ave 3, Singapore 730347 t/1 1200-1400 f/30 d/24/09/2020 a/Likes chocolates a/Needs help with Algebra` | |||
| **Edit Student** | `edit STUDENT_INDEX [n/NAME] [p/PHONE] [n/NAME] [p/PHONE] [v/CLASS_VENUE] [s/SCHOOL] [sb/SUBJECT] [y/YEAR] [t/CLASS_TIME]`<br> e.g.,`edit 1 n/Alex p/99999999 s/Meridian Junior College` | |||
| **Find Student** | `find [n/NAME] [s/SCHOOL] [y/YEAR] [sb/SUBJECT]`<br> e.g., `find n/alex s/yishun` | |||
| **Find Student** | `find [n/NAME] [s/SCHOOL] [y/YEAR]`<br> e.g., `find n/alex s/yishun` | |||
There was a problem hiding this comment.
Could you just remove the whitespace at the end of this line?
docs/UserGuide.md
Outdated
| * The order of the optional fields do not matter. e.g `n/Hans s/River Valley` will match `s/River Valley n/Hans` | ||
| * Only full words will be matched. e.g `han` will not match `hans`. | ||
| * For the name, students with a name that matches any whole keyword specified for the name will be considered to match for the name. | ||
| * For the school, students with a school that contains any keyword specified for the school will be considered to match for the school. | ||
| * For the school, students with a school that contains all keyword specified for the school will be considered to match for the school. | ||
| * Only students matching all criteria specified will be returned (i.e `AND` search). |
There was a problem hiding this comment.
You might have to rewrite this whole segment, considering that this is no longer that accurate:
- full word match only applies to name search
- year search has not been explained
Perhaps for reference, 204-206 could be:
"For name search, only students whose names contain at least one of the given keywords will be matched. Only full words will be matched, e.g han will not match hans."
"For school search, only students whose school contains the entire given keyword will be matched, e.g Yishun will match Yishun Sec but not Yishun Secondary."
There was a problem hiding this comment.
Okay thanks for pointing the potential misreading in line 204! For line 206 I don't get what you mean by "e.g Yishun will match Yishun Sec but not Yishun Secondary." as Yishun currently will match Yishun Secondary.
There was a problem hiding this comment.
Also, would "the entire given keyword" brings up the possibility of confusion as this can be interpreted to mean that the entire keyword string must be found in one chunk.
There was a problem hiding this comment.
Hmmm... perhaps it could be
"e.g Yishun will find all instances of Yishun Sec but Yishun Secondary will not."
and "whose school contain the entire set of given school keywords"
docs/UserGuide.md
Outdated
| * For the name, students with a name that matches any whole keyword specified will be matched. | ||
| * For the school, students with a school that contains all keywords specified will be matched. | ||
| * For the year, only students with the same year will be matched. (See below for more notes) |
There was a problem hiding this comment.
Perhaps it'd be clearer if you phrased it as "For xxx search"
e.g "For name search", "For school search" and "For year search"
"with a name that" and "with a school that" could be further shortened to "whose name/school"
I think by "notes" you mean "examples"?
There was a problem hiding this comment.
Oops I left it out by accident. I meant more elaboration for how the year is parsed and interpreted by Reeve. Hmm I feel saying "for name search", "for school search" etc feels like there is only one criteria they can use instead of multiple as in our app. If it's better, I've just changed it to "for the name criteria" etc!
docs/UserGuide.md
Outdated
| @@ -268,28 +268,19 @@ Format: `find [n/NAME] [s/SCHOOL] [y/YEAR]` | |||
| * At least one of the optional fields must be provided. | |||
| * The order of the optional fields do not matter. e.g `n/Hans s/River Valley` will match `s/River Valley n/Hans` | |||
| * Only full words will be matched. e.g `han` will not match `hans`. | |||
There was a problem hiding this comment.
You will still have to update this line because it is specific to name-search
Codecov Report
@@ Coverage Diff @@
## master #214 +/- ##
=========================================
Coverage 78.53% 78.53%
Complexity 1155 1155
=========================================
Files 157 157
Lines 3503 3503
Branches 407 407
=========================================
Hits 2751 2751
Misses 611 611
Partials 141 141 Continue to review full report at Codecov.
|
Fixes #153
Fixes #154