search

nus-cs2113-AY2324S1 / pe-dev-response

0 stars 0 forks source link

Instructions for "Initial Launch" in DG are not accurate #962

Open nus-pe-bot opened 12 months ago

nus-pe-bot commented 12 months 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.

The jar of the most recent relases (i.e. v2.1) is called "athleticli.jar"; see image.png

AFter I've performed the first two steps from the "Initial Launch" section, the "Initial Launch" section says that one should launch the program via the "java -jar AthletiCLI.jar" command (see screenshot: image.png ); however, as the name "AthletiCLI.jar" doesn't match the actual name of the jar (which instead is "athleticli.jar), running this command results in an error.

See screenshot of the error here: image.png

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

DaDevChia commented 12 months ago

Team's Response

Thanks for pointing this out.

When we released v2.1, we used athleticli.jar instead of AthletiCLI.jar as the file name, but did not update the instructions in UG and DG accordingly. Most operating systems (e.g., Windows and macOS) are case-insensitive to file names, so this command will still work correctly. We presume that you are using a Linux system, which is case-sensitive by default.

By Constraint-Platform-Independent, software should work on the Windows, Linux, and macOS platforms. However, since your issue is with the command used to run the software, not the command within our software, we don't think this issue applies to this constraint.

In fact, when you perform other operations on the three platforms, the commands used are often different. Therefore, we do not guarantee that these commands we provided are universal across platforms.

Also, the file name is not something we guarantee. For example, the file name you see in PE is [CS2113-T17-1][AthletiCLI].jar. We believe that our target users know how to modify the filename to make this command work properly.

We appreciate your suggestion, but we will mark it as "NotInScope".

Duplicate status (if any):

--