nus-cs2113-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Instructions on how to run MoneyGoWhere is poorly documented #758

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year ago

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.


Screenshot 2022-11-11 at 5.47.59 PM.png

As a user, when i keyed in the above command, it didn't work for me. After much tries, this is what worked for me : java -jar "[CS2113T-W11-1][MoneyGoWhere].jar"

There are 2 faults in this command i was instructed to do : java -jar MoneyGoWhere.jar

  1. Firstly, the lack of " "
  2. Secondly, the incorrect naming of the jar file

This section of the UG must have been better updated in order to reflect the actual name of the jar file more accurately. I find this a serious issue because as a user - if I follow this command and it doesn't work, there's no way for me to get this application to get started unless I have experience in CLI.


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

xzynos commented 1 year ago

Team's Response

Greetings karthikstar,

Thank you for your bug report. After careful evaluation of your bug report, the development team is rejecting this bug report due to the following reasons:

1) The user guide states that this application is "targeted at computing professionals who are familiar with CLI". Hence it is perfectly reasonable to assume that the user in question has basic computing knowledge such as:

2) The name of the application could change during every release (E.g. MoneyGoWhere-v1.0.jar, MoneyGoWhere-v2.0.jar). It is impractical to change the filename upon every release. (E.g. Printed copies are distributed to users). Hence, it was a conscious design choice to include a generic filename that is easy to distinguish from the rest of Java's arguments.

Regards, xzynos

Duplicate status (if any):

--