Branch fix ug #233
Branch fix ug #233
Conversation
QinHaichen12
added
priority.Medium
Codecov ReportAll modified and coverable lines are covered by tests ✅
|
|
Find Session now always displays "Matching sessions found" and does not include the session names |
| - Words in `UPPER_CASE` are the parameters to be supplied by the user.<br> | ||
| e.g., in `add_member n/NAME`, `NAME` is a parameter that can be used as `add_member n/John Doe`. | ||
| - Items in square brackets are optional.<br> | ||
| - Words in `UPPER_CASE` are the placeholders you'll replace with your own input.<br> |
There was a problem hiding this comment.
Fantastic wording, that helps a lot.
Why is UPPER_CASE like this instead of UPPER CASE though, or do you think it doesn't matter either way?
There was a problem hiding this comment.
I think in the words formatted as such underscore is used to separate words, assumed that its a convention
| - Items in square brackets are optional.<br> | ||
| - Words in `UPPER_CASE` are the placeholders you'll replace with your own input.<br> | ||
| e.g., in `add_member n/NAME`, `NAME` can be replaced with `John Doe ` The full command will be `add_member n/John Doe`. | ||
| - Fields in `[square brackets]` are optional. You can choose to include them or leave them out.<br> |
There was a problem hiding this comment.
Are we using "fields", "parameters" or sth else going forwards?
There was a problem hiding this comment.
fields are used in the e.g. statements so i changed to that
| e.g., `n/NAME [tag/TAG]` can be used as `n/John Doe tag/friend` or as `n/John Doe`. | ||
| - Items with `…` after them can be used multiple times, including zero times.<br> | ||
| e.g., `[tag/TAG]…` can be used as ` ` (i.e., 0 times), `tag/friend`, `tag/friend tag/family`, etc. | ||
| - Fields with `…` after them can be used multiple times or not at all.<br> |
There was a problem hiding this comment.
technically, we always use ... in conjunction with [] so this addition is incorrect.
practically, I think this way is indeed easier to read.
wdyt?
There was a problem hiding this comment.
in that case should we change delete_session from delete_session s/NAME m/INDEX… to delete_session s/NAME m/INDEX [m/INDEX]…?
|
lgtm |
starchypotatocode
merged commit 8173435
into
AY2425S1-CS2103T-W14-3:master
Don't merge yet, changes are pending