search

nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Unnecessary ref boxes used #3384

Open nus-pe-bot opened 2 years ago

nus-pe-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.

Steps to reproduce:

  1. Implementation --> Tabs System.

be used to refer to another sequence diagram which is used for understanding. However, here, it is just used to convey "Implementation hidden". This is unnecessary and confuses the reader.


Expected: Shown in diagram.


Actual: Omitted from diagram.


Screenshots:

image.png

[original: nus-cs2103-AY2122S1/pe-interim#3444] [original labels: severity.VeryLow type.DocumentationBug]

aaronloh852 commented 2 years ago

Team's Response

Bug accepted. A short writeup could be added at the bottom to indicate that other paths in the sequence diagram are omitted for clarity

Duplicate status (if any):

--