nus-pe-bot
commented
9 hours ago [IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]
Team's Response
We understand that the readability can be increased by adding more white space and headers. However, most information as stated is required since we need the users to understand the nuances of date command since it is implemented differently. Hence, this is a purely cosmetic issue, and should be set to Very Low.
For example, for the section with "In the command format, the brackets around n/NAME, p/PHONE, and e/EMAIL indicate that these fields are flexible in their order and selection. This does not mean that all three fields can be left out, at least one must be provided.", it needs to be specified in detail since users might misunderstand that all 3 fields can be left out, when in fact, it should not be the case. Therefore, this point was emphasised to allow users to understand that at least one parameter must be present, even though they may be flexible in order and selection.
The other bug is considered a duplicate to this as both bugs are about the length of the additional details section of date command.
Items for the Tester to Verify
:question: Issue severity
Team chose [severity.VeryLow]
Originally [severity.Low]
- [ ] I disagree
Reason for disagreement: [replace this with your reason]
In this section the description of the date command is quite long. This could make it tougher to read for readers and I think it could be improved with a few simple simplifications to shorten the sentences
I think some of these lines can be easily shortened for the readers' convenience. For instance, the second line in the screenshot above says that at least one field must be provided. This is repeating the information in the first bullet point, and so is a little bit unnecessary, and can be removed shortening the section for the user. In addition, the user guide already states at the start that parameters can be in any order, and as such the first line in the screenshot above could also be removed.
Furthermore, in bullet point number 9, could that sentence be shortened by just saying that the date entered needs to be valid, and just provide one example instead of explaining what a valid date is? If they're doctors, it may be fair to expect that they understand how dates work.