Update UG and Diagrams #143
Conversation
AbdulrahmanAlRammah
added
the
severity.Low
Codecov ReportAll modified and coverable lines are covered by tests ✅ |
docs/UserGuide.md
Outdated
|
|
||
| Sorts the list of persons being viewed by name or date of last visit in ascending or descending order. | ||
|
|
||
| Format: `sort paramater/order` |
There was a problem hiding this comment.
Do you think it would make sense to write it as sort [n/ORDER] [d/ORDER]? For consistency with the other command formats.
If you do decide this current format is better, take note of the "paramater" -> "parameter" spelling error
There was a problem hiding this comment.
then that kind of assumes that you can just type sort which I haven't built in.
There was a problem hiding this comment.
Makes sense, fair enough!
docs/UserGuide.md
Outdated
| Format: `sort paramater/order` | ||
|
|
||
| * Sorts the displayed list of persons according to the specified order. | ||
| * Order can be specified as ascending by leaving the order blank or **asc** **ascending** |
There was a problem hiding this comment.
Maybe a "/" between asc and ascending so it's clearer that they're both equal?
docs/UserGuide.md
Outdated
| * Order can be specified as descending by **descending** or **desc** | ||
|
|
||
| Examples: | ||
| * `sort n/` sorts name in ascending order. |
There was a problem hiding this comment.
Perhaps "sorts by name in ascending order."?
There was a problem hiding this comment.
LGTM!
One thing to mention--when I try to view the Model Class Diagram on the website itself, it shows up without an arrowhead. But the UML diagram generated by the code has one, so I'm not sure if it's a MarkBind issue. To be checked: does the website display the UML diagram correctly?
Closes #136
Closes #137
Updated UG for Sort Command instructions.
Edited the Model Diagram to include PersonComparator dependency and specify remarks as 1 to clarify that we only allow one remark (as this is not abundantly obvious unlike the other terms.