yeozongyao / pe

0 stars 0 forks source link

Wrong input command in UG #1

Open yeozongyao opened 2 months ago

yeozongyao commented 2 months ago

image.png Above is the stipulated command.

image.png However, above is the file name needed to run the jar file.

This is a documentation bug that will significantly hinder users in even opening the programme should they not understand how jar files run. Perhaps, more instructions could be given with regards to the flexibility of the naming. I am debating between a medium and low but I shall stick with a low severity.

nus-pe-script commented 2 months ago

Team's Response

The user guide was written for our github repository, where the name of the jar file is correct.

image.png

This bug is very specific to the context of the PE, where all jar file

The 'Original' Bug

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

Wrong JAR file name in UG

In the UG, the JAR name (in step 4) is Classify.jar, which is not the same as what I downloaded from the zip ([CS2113-T13-3][Classify].jar). This may cause confusion for new users.

image.png

image.png


[original: nus-cs2113-AY2324S2/pe-interim#978] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

The user guide was written for our github repository, where the name of the jar file is correct.

image.png

This bug is very specific to the context of the PE, where all jar file names are changed. Not only this is out of our control, we find it hard to argue that this is a bug at all, since the UG naming does indeed match the jar release which the typical user would use and not the exam version.

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 response Team chose [`response.Rejected`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]