search

nus-cs2113-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Missing information. #2967

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 years 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.

image.png

In the above diagram, in the following part

image.png

It would be hard for the reader to know what parameters does returns parameter refer to.

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

theodorekwok commented 2 years ago

Team's Response

From the yellow note, it states clearly that user input details are stored as parameters. So an explanation for what parameters refer is already given.

Downgrading this severity to low as the reader has reference to the note to know that the parameters refer to the attributes of the instrument thus this would barely inconvenience the reader.

Duplicate status (if any):

--