RainyCodeWizard / pe

0 stars 0 forks source link

Quick Start section in UG #1

Open RainyCodeWizard opened 3 years ago

RainyCodeWizard commented 3 years ago

image.png

Quick start section asks us to run the jar file using this command: java -jar tp.jar However, in the github release page, their file name is different. image.png

A user new to CLI might not know this and he/she will be unable to run the file.

nus-pe-bot commented 3 years ago

Team's Response

No response provided.

The 'Original' Bug

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

Wrong name for jar file

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.


As shown in the screenshot, the name of the jar file is outdated. image.png


[original: nus-cs2113-AY2021S2/pe-interim#900] [original labels: severity.High type.DocumentationBug]

Their Response to the 'Original' Bug

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

We failed to change the particular part in our final document.

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.Low] Originally [severity.Medium]

Reason for disagreement: This can be an important bug if the user follows the user guide diligently. This is because they will be unable to run the jar file. Hence, it can cause major problems for users who follow the instruction in the UG. I feel it should be at least of Medium severity.