nus-cs2113-AY2223S1 / pe-dev-response

0 stars 0 forks source link

UG Section for Merging a data file: Merge-File is poorly documented #784

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.20.49 PM.png

This instructions in the UG for this feature merely states using a PATH_STRING and shows an example of usage. However, it does not tell the user how to obtain this path string in their own computer, hence it is very difficult to run this feature unless the user has prior knowledge on how to obtain the path strings.

My recommendation will be to show a step by step guide to user on how to obtain path string (for both windows and mac users) so that they can use the path string to run this command.


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

LokQiJun commented 1 year ago

Team's Response

Greetings,

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:

Best Regards

Duplicate status (if any):

--