Chang-CH / pe

0 stars 0 forks source link

Inconsistent use of elipsis #14

Open Chang-CH opened 3 years ago

Chang-CH commented 3 years ago

Format notes uses "…", whereas for the rest of the commands "..." is used.

image.png

For example, in command summary: image.png

nus-pe-bot commented 3 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]

Inconsistent command format

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.


Notation guide indicates

image.png

Ellipsis is placed inside in this case in Command Summary:

image.png

No indication of what ellipsis outside fields were provided.


[original: nus-cs2103-AY2122S1/pe-interim#2319] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

"..." has been explained in the first image to indicate when items with it can be used multiple times. While it is true that the one provided as an EXAMPLE in the explanation is different from the one used in the Command Summary for Find (second image), the meaning of the use of the ellipses should still be obvious as it is commutative with the square brackets. ie [-n NAME]... is the same as [-n NAME...]

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)

Reason for disagreement: This issue concerns the inconsistent usage of symbol and 3 full stops .... This is a cosmetic issue.

The alleged duplicated issue concerns the syntax of where the ellipsis is placed ([item…] vs [item]…) to indicate variable arguments. This is a syntax error.


:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: As per description of VeryLow: A flaw that is purely cosmetic and does not affect usage e.g., a typo/spacing/layout/color/font issues in the docs or the UI that doesn't affect usage. Only cosmetic problems should have this label.

This is a valid issue.


:question: Issue severity

Team chose [severity.Low] Originally [severity.VeryLow]

Reason for disagreement: - Does not affect usage, purely cosmetic