search

alfred-leong / pe

0 stars 0 forks source link

Inconsistencies in command format in user guide #24

Open alfred-leong opened 2 years ago

alfred-leong commented 2 years ago

Some commands include square brackets for the input while others do not

image.png

image.png

nus-pe-bot commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Format for Listing Acceptable Commands is Inconsistent

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.

Format for listing acceptable commands should be standardised across features.

Screenshot 2022-11-11 at 5.37.58 PM.png

Screenshot 2022-11-11 at 5.37.32 PM.png

[original: nus-cs2113-AY2223S1/pe-interim#1041] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

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

Format of listing multiple commands as acceptable is not standarized for user guide

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: [replace this with your explanation]

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]