nus-pe-bot
commented
3 years ago Team's Response
Refer to #925.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Misleading use of ...
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.
In the UG, it is shown that ... means a certain field can be used more than once.
I dont think thats the case for this example given in the DG since name can only be added once
[original: nus-cs2103-AY2021S2/pe-interim#925] [original labels: severity.Low type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
That definition of the ellipsis is meant for the user guide, not for the developer guide. For the developer guide, it is clear what the ellipsis means.
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 explanation]
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: That is even worse, since you are using a symbol that you did not explain in the DG. Ellipses, as shown in both the UG and DG have different meanings, making it confusing for the user especially since it is not explained in the DG what the ellipsis is for. You cannot assume the reader knows which meaning you are trying to implement.
In the UG, it is shown that … means a certain field can be used more than once.
I dont think thats the case for this example given in the DG. This happens several times and I shall leave it here. Don't want to penalise y'all too many times :)