tangphi / pe

0 stars 0 forks source link

UG Incorrect Description of Edit Command #3

Open tangphi opened 1 year ago

tangphi commented 1 year ago

UG Command Summary states: Words in curly brackets { } are optional parameters to be supplied by the user

In the UG, the parameters after edit/upc [UPC] are given {} optional parameters. Screenshot 2023-04-14 at 4.54.22 pm.png

However, the command edit/upc 000000001 for Edit gives an error eventho item with upc 000000001 is in the list.

Screenshot 2023-04-14 at 4.56.25 pm.png

nus-se-script commented 1 year ago

[IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]

Team's Response

No details provided by team.

The 'Original' Bug

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

user guide states 'edit' command only needs upc as required parameters but entering that alone does not work

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.


image.png

image.png


[original: nus-cs2113-AY2223S2/pe-interim#1564] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

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

Cosmetic presentation issue that can be done better. May have been better to have added (MUST INCLUDE AT LEAST 1), but after discussion, the dev team feels that this is not a medium severity issue as it does not impact the normal operation of the product and causes only minor inconvenience.

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 reason]