search

nus-cs2113-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Not clear what the 'parameters' refer to in the diagram. #2978

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 which details the command execution of setting the stock with the new values not sure what the parameters does "return parameters before edit" refer to.

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

KVignesh122 commented 2 years ago

Team's Response

Screenshot 2021-11-15 at 11.28.30 AM.png

It is fairly clear from this section of the DG that parameters refer to the various attributes of the financial instrument. In this case, the UML sequence diagram for editing a stock clearly indicates that the attributes like "name" are being edited. So, these are the parameters, whose old and new values are returned by the method, before and after the edit respectively.

Bug is rejected and severity downgraded to Low as the dg already provides a few references to what parameters are.

Duplicate status (if any):

--