kyrenechua / pe

0 stars 0 forks source link

Inconsistent format used in UG #22

Open kyrenechua opened 1 year ago

kyrenechua commented 1 year ago

image.png

image.png

The square brackets for ID is not used while there is a square bracket for all the other pieces of information. This could confuse users as to whether there should be square brackets when adding inputs.

nus-pe-script 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: I disgaree that this is an issue of severity very low as it is not a cosmetic issue. Rather, the inconsistencies in the user input could cause confusion to the users. Hence, it should be of severity low. Thank you.