search

nus-cs2113-AY2223S1 / pe-dev-response

0 stars 0 forks source link

In the command summary the format of inputs doesn't match the actual use cases #919

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.

For example:

Delete:

image.png

image.png

It can be seen that the format recommended has the fn/ before the flight number and yet the example given on the right and in the main UG does not have the fn/ prefix. In the actual running of the program giving fn/ will also cause the cli to bug out.

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

JordanKwua commented 1 year ago

Team's Response

Change the severity to be low as it is a typo in the command summary

Duplicate status (if any):

--