soc-se-bot
commented
2 years ago Team's Response
No details provided by team.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Confusing usage of square brackets in command summary
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.
Square brackets were used multiple times in the command summary table without explanation, and encapsulating different things on different occasions.
[original: nus-cs2113-AY2223S1/pe-interim#482] [original labels: severity.Low type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
Should fix issue with brackets not being consistent
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)
- [x] I disagree
Reason for disagreement: Original bug that my issue was tagged to is mentioning the clarity of the square brackets. However, I understand that the square brackets are used to signify that the field is optional. My catch here is that for Modifying a patient's record , there is no specification that only one of the optional fields can be used at the same time if you compare it to Modifying a patient's prescription.
the additional () brackets with or keywords to be exact.
So I believe its more of a format typo?
Does not state in command summary that it must be only one of the three n/ g/ or d/