search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Specifying some common invalid user input in UG & DG #2316

Open nus-pe-bot opened 4 months ago

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

Problem & Flaw

When user input duplicated parameter for some commands (e.g. new), the app is automatically taking the first appearances of the duplicated parameters. It's better to clearly specify the behaviors of the app in UG and DG.

Explanation

image.png

Functionality Impacted

First time user, developers.

Discussion & Suggested Improvement

Better to include such common cases of invalid user input in the sample run section of the DG.

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

dtaywd commented 4 months ago

Team's Response

image.png This is not a bug. We have specified this in the user guide.

Duplicate status (if any):

--