-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update UG and DG #183
Update UG and DG #183
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please fix formatting issues
|
||
Format: `search t/TAGNAME...` | ||
Prefix | Constraints |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider adding type (mandatory/optional) column? Can consider doing a merged column filled with mandatory*
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Regarding this part, technically all fields are optional, but they need at least 1 of the "optional" fields. But I wasn't sure how to word this without making it even more confusing (as flagged by Jun Hiang during our UG consult) so I just got rid of the mandatory/optional column. Any suggestions on how to solve this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
e.g. `search n/Alex n/Adam st/rejected` is not allowed. | ||
<box type="tip" seamless> | ||
Tip: | ||
* You can combine multiple search categories in a single `search` command. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Incorrect formatting
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noted!
Examples of successful command execution: | ||
1. `search n/alex bernice` | ||
<br> | ||
 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure why but picture doesn't show up
What does it mean to do an `OR` search within a single category and an `AND` search across multiple categories? | ||
It's best to explain this by breaking down an example `search` command! | ||
`search n/alex bernice st/interviewed t/intern` will output applicants whose: | ||
* names contain either Alex `OR` Bernice |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Incorrect formatting
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Changes to UG:
search
andcreate
Changes to DG:
model
andstorage
class diagrams