nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Incorrect/Missing method name in Stock Sequence Diagram in DG #609

Open nus-pe-bot opened 2 months ago

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


The Stock Command Sequence diagram appears to show that the Command class is calling the activate() method from the StockActivate class. However, the code appears to be calling the start() method instead

The sequence diagram i am referring to is :

image.png

The code snippet i am referring to is :

image.png

The diagram also does not seem to state what method StockActivate is calling in StockStorage, as the line connecting to the activation bar to StockStorage is empty. Should there be a play() at this solid line too?


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

CXIA17 commented 2 months ago

Team's Response

Screenshot 2024-04-21 at 2.15.29 PM.png

This is to keep the diagram simpler.

Duplicate status (if any):

--