ZiqiuZeng / pe

0 stars 0 forks source link

misleading command for `Quick Start` #8

Open ZiqiuZeng opened 1 year ago

ZiqiuZeng commented 1 year ago

Screenshot 2023-04-14 at 5.25.48 PM.png

Since the file name of .jar does not matches the java -jar clialgo-v2.1.jar, the command fails. Even users as CS2040C students, they may not have the knowledge how to open a .jar file. It is possible for them to following the provided command.

nus-pe-script commented 1 year ago

Team's Response

The file name is consistent with the .jar file in the link provided in the UG. I think the different file name is due to the nature of the PE as they used our canvas submission instead (which has a different file name).

image.png

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: While it may be true that the file name is consistent with the .jar file in the link provided in the UG, it is important to consider the situation where the user may unintentionally change the name of the .jar file. It is not uncommon for users, particularly those who are not experts, to be unable to launch the .jar file when they accidentally rename files or make other unintended changes.

Therefore, as a developer team, it is important to anticipate this potential issue and provide clear instructions on how to launch the file with the changed name. This could include updating the quick start guide to include instructions on how to utilize the launch command for the changed file name.