soc-pe-bot
commented
1 year 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
No details provided by team.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
[DEVELOPER GUIDE] Test case under Instructions for manual testing not valid
Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.
Similar to the case in the User Guide, the following command when copied directly from the document results in:add n/John Doe p/98765431 e/johnd@nus.com rm/06-73 dr/13/09/22- 15/09/23 ng/1 rq/Kill the insect
Note the missing whitespace between the start date and the hyphen, which leads to an invalid command.
[original: nus-cs2103-AY2223S1/pe-interim#1385] [original labels: type.DocumentationBug severity.Low]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
Items for the Tester to Verify
:question: Issue duplicate status
Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)
- [ ] I disagree
Reason for disagreement: [replace this with your reason]
:question: Issue type
Team chose [type.DocumentationBug]
Originally [type.FunctionalityBug]
- [ ] I disagree
Reason for disagreement: [replace this with your reason]
This behaviour differs from the user guide which specifies that the
However, when the command is copy pasted over, this does not work.
It is not clear from the documentation alone that there is a formatting issue with the command. And the user has to do his own testing to figure out what is the proper way to type an add command.